Skip to content

Commit

Permalink
Be less vague
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Jan 26, 2025
1 parent 7b38416 commit 2a224cf
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Features added
* #13269: Added the option to disable the use of type comments in
via the new :confval:`autodoc_use_type_comments` option,
which defaults to :code-py:`True` for backwards compatibility.
A future version of Sphinx will change the default to :code-py:`False`.
The default will change to :code-py:`False` in Sphinx 10.
Patch by Adam Turner.

Bugs fixed
Expand Down
2 changes: 1 addition & 1 deletion doc/usage/extensions/autodoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1246,7 +1246,7 @@ There are also config values that you can set:
Added the option to disable the use of type comments in
via the new :confval:`!autodoc_use_type_comments` option,
which defaults to :code-py:`True` for backwards compatibility.
A future version of Sphinx will change the default to :code-py:`False`.
The default will change to :code-py:`False` in Sphinx 10.

.. xref RemovedInSphinx10Warning
Expand Down

0 comments on commit 2a224cf

Please sign in to comment.