Skip to content
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

Docstring clarifications #9877

Merged
merged 6 commits into from Sep 24, 2022
Merged

Docstring clarifications #9877

merged 6 commits into from Sep 24, 2022

Commits on Nov 21, 2021

  1. NF: Documentation clarification

    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
    Arthur-Milchior committed Nov 21, 2021
    Copy the full SHA
    3bac7bc View commit details
    Browse the repository at this point in the history

Commits on Nov 26, 2021

  1. Apply suggestions from code review

    Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
    Arthur-Milchior and jakobandersen committed Nov 26, 2021
    Copy the full SHA
    023b7f9 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    9def25b View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2022

  1. Apply suggestions from code review

    Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
    Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
    3 people committed Sep 24, 2022
    Copy the full SHA
    2d3e5fd View commit details
    Browse the repository at this point in the history
  2. plural

    AA-Turner committed Sep 24, 2022
    Copy the full SHA
    cfca7cf View commit details
    Browse the repository at this point in the history
  3. Merge branch '5.x' into doc

    # Conflicts:
    #	sphinx/addnodes.py
    #	sphinx/application.py
    AA-Turner committed Sep 24, 2022
    Copy the full SHA
    acdb405 View commit details
    Browse the repository at this point in the history