Docstring clarifications #9877
Merged
Docstring clarifications #9877
Conversation
This file contains 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
While trying to understand Sphinx, I had a few troubles and tried to improve what I found difficult. In particular: * Why "addnodes" where described as docutil nodes * whether "centered" is for deprecated text or whether it is deprecated * what is pending_xref_condition * what means "forcedly" * Why some script can take no filename while it is marked as a str argument (by consistency, I changed similarly css) * why ProductionList counted the number of rules * how come verify_needs_extensions actually verifies
jakobandersen
requested changes
Nov 21, 2021
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
|
Thanks a lot for those reviews. Sorry for not paying as much attention as I should have to the difference between directive and roles. I'll try to do better if I submit again (which will probably be the case, given that I've still not been able to do understand how to do what I was trying to do in the first place) |
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com> Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
AA-Turner
reviewed
Sep 24, 2022
# Conflicts: # sphinx/addnodes.py # sphinx/application.py
|
Thanks Arthur! A |
AA-Turner
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Clarifying some documentation sentences that I found confusing
Feature or Bugfix
### Branch
Before posting a pull request, please choose a appropriate branch:
While trying to understand Sphinx, I had a few troubles and tried to improve
what I found difficult.
In particular:
(by consistency, I changed similarly css)