gh-107298: Fix references to undocumented APIs #107304
Closed
Conversation
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
|
@serhiy-storchaka: Ok, here is a more controversial change: fix references to undocumented APIs, but don't attempt to document them. Sorry, I'm only motived to fix warnings, to make reviews more pleasant. I'm not motivated to write more documentation. So what do you think? Is it ok do that? For now, I mark this change as a draft. |
There was a problem hiding this comment.
We should not sweep problems under the carpet. Warnings serve as reminders of lacks in the documentation.
If you want to filter out undocumented symbols from other issues, it is better to add them in the nitpick_ignore list. At least we will have a list of problems to solve in one place and can work on them one by one.
|
Ok, I will try to do that. I abandon this approach. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📚 Documentation preview 📚: https://cpython-previews--107304.org.readthedocs.build/