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

fix: italics where it APPEARS to have been intended... #2219

Merged

Conversation

vwheeler63
Copy link
Collaborator

@vwheeler63 vwheeler63 commented Sep 13, 2024

...and ended up "like this" inside an .RST file which merely puts underscores on either side of the terms which APPEAR to have been intended to be standard "emphasized" words. This appears to be a possible export-translation error from some software, which put the syntax for Markdown italics rather than reStructuredText italics.

I saw one of these while I was reading and decided to LOOK for such occurrences throughout the website .RST files and found these 5 occurrences.

An issue was not created for this.


📚 Documentation preview 📚: https://writethedocs-www--2219.org.readthedocs.build/

Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds right to me. Could just be folks thinking rst but writing markdown as well, I know I do it enough.

Thanks for looking and fixing.

...and ended up "_like this_" inside an .RST file which merely
puts underscores on either side of the terms which APPEAR to
have been intended to be standard "emphasized" words, but
appears to be a possible export-translation error from some
software, which put the syntax for Markdown _italics_ rather
than reStructuredText *italics*.

I saw one of these while I was reading and decided to LOOK for such
occurrences throughout the website .RST files and found these
5 occurrences.

An issue was not created for this.
@vwheeler63
Copy link
Collaborator Author

Sounds right to me. Could just be folks thinking rst but writing markdown as well, I know I do it enough.

Thanks for looking and fixing.

My pleasure! It appears this repository is set to only permit a merge if the the commit is based on the tip of master branch by the time it is ready to merge (I'm getting "This branch is out-of-date with the base branch" message). So I will rebase these changes on master.

@plaindocs plaindocs merged commit 3cf97ba into writethedocs:main Sep 17, 2024
6 checks passed
@vwheeler63 vwheeler63 deleted the fix/italics_where_was_intended branch September 17, 2024 11:36
@vwheeler63
Copy link
Collaborator Author

@plaindocs Hi, Sam! Thank you for the invitation to collaborate! I'm honored! 😃

@plaindocs
Copy link
Contributor

Always great to see folks interested in helping fix stuff!

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.

2 participants