Skip to content

docs: improve clarity in prompts guide#3230

Closed
pdonizete wants to merge 1 commit intopallets:mainfrom
pdonizete:docs/3175-prompts-clarity
Closed

docs: improve clarity in prompts guide#3230
pdonizete wants to merge 1 commit intopallets:mainfrom
pdonizete:docs/3175-prompts-clarity

Conversation

@pdonizete
Copy link

@pdonizete pdonizete commented Feb 25, 2026

Summary

Improves wording clarity in docs/prompts.md (one file) as requested in #3175.

Changes

  • rewrote the opening paragraph into a short bullet list for readability
  • clarified recommendation around prompt with multiple=True
  • tightened wording for required=True behavior with prompt_required=False
  • clarified show_default wording for callable defaults

Scope

Documentation-only updates. No behavior changes.

Refs #3175.

@davidism davidism closed this Feb 25, 2026
@pdonizete pdonizete deleted the docs/3175-prompts-clarity branch February 25, 2026 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants