Docs: Resolve Sphinx warnings in calendar.rst #108192
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
- Add docs for HTMLCalendar.formatmonthname - Fix links to HTMLCalendar methods - Suppress links in HTMLCalendar subclass note
erlend-aasland
added
skip issue
skip news
needs backport to 3.11
erlend-aasland
commented
Aug 21, 2023
| @@ -341,7 +341,7 @@ interpreted as prescribed by the ISO 8601 standard. Year 0 is 1 BC, year -1 is | |||
|
|
|||
| .. note:: | |||
|
|
|||
| The constructor, :meth:`formatweekday` and :meth:`formatmonthname` methods | |||
| The constructor, :meth:`!formatweekday` and :meth:`!formatmonthname` methods | |||
There was a problem hiding this comment.
Ignoring valid warnings will only make us forget about the issue. We already have too many open and forgotten issues.
If the goal is to suppress warnings, just add the corresponding option to Sphinx invocation.
|
It seems to me this PR risks running stale. Instead of contributing to the huge number of stale PRs, I'll close this issue right away. The status quo is not better or worse than this PR (the current links don't work anyway). I created issue gh-108202 for the undocumented methods of the |
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.
Add docs for HTMLCalendar.formatmonthname📚 Documentation preview 📚: https://cpython-previews--108192.org.readthedocs.build/