Add rstbebe to hooks + apply fixes #1121
Merged
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
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
requested review from
aaschaer,
ada-globus,
derek-globus,
kurtmckee,
m1yag1 and
MaxTueckeGlobus
as code owners
kurtmckee
approved these changes
Dec 18, 2024
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.
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-blockalso 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/