Skip to content

Commit b1c6657

Browse files
authored
Vale check modified only and ignore roles (#1190)
* Vale: switch filter mode to "added" * Vale: Ignore :class: inline roles * Vale: Ignore :class: inline roles * Vale: Ignore :meth: inline roles * Vale: Ignore :py:class: and :py:meth: inline roles
1 parent 07e5cdd commit b1c6657

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

.github/workflows/docs-style.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ jobs:
2626
files: docs
2727
reporter: ${{ inputs.vale_reporter || 'local' }}
2828
level: error
29-
filter_mode: nofilter
29+
filter_mode: added
3030
fail_on_error: true
3131
vale_flags: "--config=docs/.vale.ini"

docs/.vale.ini

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,14 @@ BasedOnStyles = Vale, Google
2929

3030
# Removing Google-specific rule - Not applicable under some circumstances
3131
Google.WordList = NO
32-
Google.Colons = NO
32+
Google.Colons = NO
33+
34+
[formats]
35+
# Format associations appear under
36+
# the optional "formats" section.
37+
38+
[*]
39+
# Format-specific settings appear
40+
# under a user-provided "glob"
41+
# pattern.
42+
TokenIgnores = (:class:\x60.*\x60|:meth:\x60.*\x60|:py:class:\x60.*\x60|:py:meth:\x60.*\x60)

docs/source/user_guide/operators.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,8 @@ This example instantiates operators with other operators:
279279
min_max = ops.min_max.min_max(displacement)
280280
281281
This automatically connects the matching ``displacement`` output with the
282-
matching ``min_max`` input. You can also use the :py:meth:`connect()
283-
<ansys.dpf.core.dpf_operator.Operator.connect>` method to manually connect
284-
the outputs of one operator to the inputs of another operator:
282+
matching ``min_max`` input. You can also use the :py:meth:`connect()<ansys.dpf.core.dpf_operator.Operator.connect>`
283+
method to manually connect the outputs of one operator to the inputs of another operator:
285284

286285
.. code-block:: python
287286

0 commit comments

Comments
 (0)