Skip to content

AI junk - #3733

Closed
Sasireddy001 wants to merge 3 commits into
pallets:mainfrom
Sasireddy001:docs/prompts-import-click
Closed

AI junk#3733
Sasireddy001 wants to merge 3 commits into
pallets:mainfrom
Sasireddy001:docs/prompts-import-click

Conversation

@Sasireddy001

@Sasireddy001 Sasireddy001 commented Jul 29, 2026

Copy link
Copy Markdown

Description

The Click documentation uses a custom Sphinx directive .. click:example:: that pre-imports click into the execution namespace when building the docs. However, the rendered source code blocks do not include import click.

This means users who copy the examples from the documentation will get NameError: name click is not defined unless they add the import themselves.

This change adds import click to each .. click:example:: and python example in docs/prompts.md so the snippets are self-contained.

Verification

  • Confirmed the click:example directive does not render import click automatically.
  • Verified examples use @click decorators and click.echo/click.option without an explicit import.
  • No open or merged PR was found addressing this.

sasidharmopuru added 3 commits July 29, 2026 17:40
Adds import click to prompts.md examples so they can be copied and run directly.
Fix import click formatting so the documentation builds correctly.
Fix trailing whitespace in import click additions.
@davidism davidism closed this Jul 29, 2026
@davidism davidism changed the title docs: add missing import click to prompts examples AI junk Jul 29, 2026
@davidism

Copy link
Copy Markdown
Member

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