Doc/fix minor formatting and style issues #443
Merged
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
…fix_minor_formatting_issues
…fix_minor_formatting_issues
…fix_minor_formatting_issues
github-actions
bot
added
the
documentation
PipKat
changed the title
RobPasMue
approved these changes
Apr 25, 2024
Member
RobPasMue
left a comment
RobPasMue
left a comment
There was a problem hiding this comment.
Overall edits LGTM! Just left a minor comment
doc/source/content-writing/rst-files-writers/rst-format-rules.rst
Outdated
Show resolved
Hide resolved
Add corrections for mistakes found by Roberto and Revathy Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
github-actions bot
pushed a commit
that referenced
this pull request
Apr 25, 2024
* Minor fixes * Minor fixes based on skimming rendered doc * Additional edits * Fix Vale issues * Resolve doc build errors * Edit to add-sphinx-extensions * Resolve link issues causing doc build failure * Fix mistake * Apply suggestions from code review Add corrections for mistakes found by Roberto and Revathy Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> --------- Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
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.
The edits made in this PR are minor, mostly formatting and stye issues found while skimming the rendered documentation. Note that when there were multiple links to the same topic on a page, I removed all but the first link. On any given page, you only want to link on the first reference (unless the page is long and having another link much lower on the page would save the user from a lot of scrolling). Linking each time ends up giving the page a polka dot appearance.
@Revathyvenugopal162 I ran into the same problem running Vale locally here as I did on PyAnsys Quarto Cheat Sheet PR #11.