Skip to content

Commit

Permalink
docs: Add code spell hook changes in vale migration guide (#464)
Browse files Browse the repository at this point in the history
  • Loading branch information
dipinknair authored Apr 18, 2024
1 parent 7170184 commit 95c8a24
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion doc/source/migrations/docs-style-vale-version-update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ as input for the ``doc-style`` action like below.
token: ${{ secrets.GITHUB_TOKEN }}
vale-version: "3.4.1"
In any of the preceding conditions there are two changes needs to implemented:
In any of the preceding conditions, there are two mandatory changes and one optional (depending on
the repository setup) needs to implemented:

1. Update ``Vocab/ANSYS`` path

Expand All @@ -43,5 +44,20 @@ In any of the preceding conditions there are two changes needs to implemented:
BasedOnStyles = Vale, Google
Vale.Terms = NO
3. Update ``codespell`` hook

If your repository includes a ``codespell`` hook in the ``.pre-commit-config.yaml`` file,
utilizing the ``accept.txt`` file, it necessitates modification to reflect the new path
as provided below.

.. code:: yaml
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]
Finally, verify that the ``doc-style`` action is functioning correctly with the latest changes applied.
Run the action and ensure that the documentation style checks are performed without any issues.

0 comments on commit 95c8a24

Please sign in to comment.