-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
gh-141004: Document soft-deprecated symbols #141634
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ZeroIntensity
wants to merge
12
commits into
python:main
Choose a base branch
from
ZeroIntensity:document-internal-symbols
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+70
−0
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
596d4ec
Document soft-deprecated symbols
ZeroIntensity 5297d4a
Add a note about completeness.
ZeroIntensity 5559162
Fix typo.
ZeroIntensity 5516aeb
Remove changes to stable.rst
ZeroIntensity d02736d
Move PyLong* symbols to long.rst
ZeroIntensity 0d0ca9a
Document PyAsyncGenASend_CheckExact()
ZeroIntensity 8f2e924
Document PyFile_NewStdPrinter() and PyStdPrinter_Type
ZeroIntensity c151684
Document PySet_MINSIZE
ZeroIntensity df5566c
Document the values of PyLong* macros.
ZeroIntensity 8bcf20b
Apply suggestions from code review
ZeroIntensity e794b69
Update Doc/c-api/file.rst
ZeroIntensity 9e282c6
Update Doc/c-api/long.rst
ZeroIntensity File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is indeed not obvious. All the more reason for the docs to mention it, if we want to add docs.
What about something like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too fond of using
.. deprecatedfor this, because thenext(or whatever version we put in there) would imply that it's fine to use for earlier versions. We don't want people using this on any version.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fair.
On the other hand, without
.. deprecated, automated tools won't be able to tell that these are deprecated.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, I don't think our documentation is sufficient for automated tools yet. (For example, we document a bunch of macros as functions, which would break if used to generate bindings.) I do agree that we should eventually get C API documentation to that point, but that's a project I plan to work on once #141004 is done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still think
.. deprecatedis better in the mean time. But I won't block the PR on that :)