Skip to content

Conversation

@dipinknair
Copy link
Collaborator

@dipinknair dipinknair commented Feb 21, 2024

Update Vale version 3.1.0

  doc-style:
    name: Documentation Style Check
    runs-on: ubuntu-latest
    steps:
      - name: PyAnsys documentation style checks
        uses: ansys/actions/doc-style@v5
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          vale-version: "3.1.0"

current .vale.ini

# Define the Ansys vocabulary
Vocab = ANSYS

Status

E100 [vocab] Runtime error

'config/vocabularies/ANSYS' directory does not exist

Execution stopped with code 1.
Error: Error: The process '/home/runner/vale' failed with exit code 2

Update Vocabularies path

Current New
Vocab/ANSYS config/vocabularies/ANSYS

Status

Fails because Vale.Terms are on by default.

Turn off Vale.Terms

Update .vale.ini

# Apply the following styles
[*.{rst}]
BasedOnStyles = Vale, Google
Vale.Terms = NO

Status ✔️

@dipinknair dipinknair changed the title MAINT: Udate vale version 3.1.0 MAINT: Update vale version 3.1.0 Feb 21, 2024
@github-actions github-actions bot added maintenance Package and maintenance related CI/CD labels Feb 21, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 21, 2024
@dipinknair dipinknair marked this pull request as ready for review February 21, 2024 07:58
@dipinknair dipinknair requested a review from RobPasMue February 21, 2024 07:58
@dipinknair dipinknair self-assigned this Feb 21, 2024
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Apart from my minor suggestion - LGTM!

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

Labels

documentation Improvements or additions to documentation maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants