Skip to content

Conversation

@sirosen
Copy link
Member

@sirosen sirosen commented Dec 18, 2024

Almost all of these are simple backtick substitutions and were part of
our real user-facing documentation.

One exception: because rstbebe detects code blocks by looking for a
.. code-block::, it did not detect one case where :: was used.
Switching to a .. code-block also improves blacken-docs detection.

rstbebe also does not detect RST comments (at least, current version),
so there are "unnecessary" fixes in RST comments to make it pass.
These are only in a couple of places.


📚 Documentation preview 📚: https://globus-sdk-python--1121.org.readthedocs.build/en/1121/

Almost all of these are simple backtick substitutions and were part of
our real user-facing documentation.

One exception: because rstbebe detects code blocks by looking for a
`.. code-block::`, it did not detect one case where `::` was used.
Switching to a `.. code-block` also improves blacken-docs detection.

rstbebe also does not detect RST comments (at least, current version),
so there are "unnecessary" fixes in RST comments to make it pass.
These are only in a couple of places.
@sirosen sirosen added the no-news-is-good-news This change does not require a news file label Dec 18, 2024
@sirosen sirosen merged commit 3993dc9 into globus:main Dec 19, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-news-is-good-news This change does not require a news file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants