bot: eliminate problematic xrefs from SopelWrapper docs
#2442
Conversation
This file contains hidden or 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
The formatting, in particular, is what was problematic here. Sphinx doesn't provide a way to negate the monospace formatting of a :meth: reference when using a custom title, so the only way to avoid having random monospace words in the middle of this paragraph is... rewriting to eliminate the xrefs. Which is to say, if there's a better answer to this question (https://stackoverflow.com/q/45741326/5991) in the future, we can put this back the way it was.
Exirel
approved these changes
Apr 8, 2023
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
Aw... I thought I had a trick to prevent that, but actually I don't. So let's go with that.
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.
Description
The formatting, in particular, is what was problematic here. Sphinx doesn't provide a way to negate the monospace formatting of a
:meth:reference when using a custom title, so the only way to avoid having random monospace words in the middle of this paragraph is... rewriting to eliminate the xrefs.Which is to say, if there's a better answer to this question in the future, we can put this back the way it was.
Checklist
make qa(runsmake qualityandmake test)make testlocally butmake qualitywas indeed fine.