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

Doc: Developer reference update #3755

Merged
merged 2 commits into from Jun 28, 2023
Merged

Conversation

rdrll
Copy link
Contributor

@rdrll rdrll commented Jun 28, 2023

Description

Major update on the Black classes and the Black exceptions page in the Developer reference.

They now matched with the current code base.

  • All Classes under src/black are now documented
    • Created two secondary title under the top level Black classes: Black classes (for non-Enum classes) and Enum classes to improve architectural clarity. (Previously the Enum class in the rst file was wrote as a parallel top level title yet it's actually a subsection under the top level title Black class)
  • All exceptions are now documented
  • Modified a few docstrings in src/black/handle_ipynb_magics.py and src/black/trans.py to conform to the rst syntax (enforced by Sphinx).
    • The docstrings were modified to resolve two types of errors that would raise by Sphinx when rendering the rst files with the original docstrings: Block quote ends without a blank line; unexpected unindent. and Bullet list ends without a blank line; unexpected unindent. .
    • These docstrings were not issue before because these Classes were not documented previously, so it won't fetched and examined by Sphinx.
  • Modified the note on the Developer reference main page.
    • It's now stating that only the Black functions part is outdated, while others have been updated to the latest version.

Please let me know if any changes are needed!

Checklist - did you ...

  • Add an entry in CHANGES.md if necessary?
  • Add / update tests if necessary? not necessary
  • Add new / update outdated documentation?

@github-actions
Copy link

diff-shades reports zero changes comparing this PR (0b83f53) to main (63481bb).


What is this? | Workflow run | diff-shades documentation

@JelleZijlstra JelleZijlstra merged commit f01aaa6 into psf:main Jun 28, 2023
44 checks passed
@JelleZijlstra
Copy link
Collaborator

Thanks!

I'm not sure though how useful this "Developer Reference" is. I never look at it, and inevitably it's going to go out of date again.

@rdrll rdrll deleted the dev_ref_update branch June 30, 2023 00:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants