Skip to content

docs: clarify strict_optional behavior - #21892

Open
Whning0513 wants to merge 2 commits into
python:masterfrom
Whning0513:docs/21658-strict-optional
Open

docs: clarify strict_optional behavior#21892
Whning0513 wants to merge 2 commits into
python:masterfrom
Whning0513:docs/21658-strict-optional

Conversation

@Whning0513

Copy link
Copy Markdown

What does this PR do?

Clarifies the strict_optional configuration documentation:

  • states that the config option disables optional checking only when set to false;
  • replaces the unhelpful warning wording with a direct link to the explanation of optional types.

This keeps the config-file and command-line documentation consistent.

Fixes #21658

Copilot AI lite review requested due to automatic review settings August 25, 2026 06:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies strict_optional behavior and aligns configuration-file and command-line documentation.

Changes:

  • Documents that optional checking is disabled only when set to false.
  • Replaces warning text with explanatory links.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/source/config_file.rst Clarifies strict_optional = false behavior.
docs/source/command_line.rst Updates warning guidance and links to further explanation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants