Skip to content

Conversation

RobPasMue
Copy link
Member

As it is being done in other PyAnsys projects, vale has been implemented. Vale is a linter which eases the review process to the documentation team by detecting common mistakes and forcing the developer to follow the Google styler guidelines when writing the docs.

@PipKat please proceed to solve the existing errors when possible. Thanks in advance!

@PipKat
Copy link
Member

PipKat commented Jul 22, 2022

After discussing with @RobPasMue, we will await for PR # 655 to be merged because it will address many of the Vale guideline exceptions found in his documentation style check. We will then update this Vale branch, which I will use to resolve the remaining issues.

@PipKat
Copy link
Member

PipKat commented Jul 25, 2022

@RobPasMue I ended up with the Update Branch button on the PR for my overall edit to the pyfluent repo. It brought in your Vale changes, which I didn't expect. I ended up doing the fixes to resolve the issues in my PR, which was then approved and merged. I've pulled main into this branch.

@PipKat
Copy link
Member

PipKat commented Jul 25, 2022

@dnwillia-work @akaszynski
I pulled main into Roberto's PR so that it could complete successfully with my Vale issues addressed.

@RobPasMue
Copy link
Member Author

Hi @PipKat! From the log of commits in PR #655 it looks like at some point you merged this branch into the PR branch, making my changes already available in the repo. So, it's fine. All this changes are already available in the repository. In fact, this PR will cause 0 changes so let me just close it.

@RobPasMue RobPasMue closed this Jul 26, 2022
@RobPasMue RobPasMue deleted the doc/implement-vale branch July 26, 2022 05:26
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