Edit doc overall based on PyAnsys doc style guidelines #655
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
PipKat
commented
Jul 22, 2022
Now the latest one did not pull the docker image. Not sure why. We did add a 23.1 image today, let me check.... |
It looks ok now after a few retries. |
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
PipKat
commented
Jul 25, 2022
Incorporate reviewer comments Co-authored-by: Alex Kaszynski <akascap@gmail.com>
PipKat
commented
Jul 25, 2022
Attempt to fix failing style check
smf2001
reviewed
Jul 25, 2022
smf2001
approved these changes
Jul 25, 2022
…verall_edit_for_PyAnsys_style
dnwillia-work
approved these changes
Jul 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
PyAnsys libraries are to follow the Google developer's style guide, which uses sentence case for headings. It also recommends active voice, present tense and short, clear sentences. Once Vale is implemented in the Fluent repos, it will catch all violations of the Google guidelines. Vale has been run on this FR and all violations are fixed. New contributions must pass the Vale style check.