Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vale check modified only and ignore roles #1190

Merged
merged 5 commits into from
Oct 10, 2023
Merged

Vale check modified only and ignore roles #1190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e63de2c
Vale: switch filter mode to "added"
PProfizi Oct 9, 2023
2eb9c33
Vale: Ignore :class: inline roles
PProfizi Oct 9, 2023
d4fed25
Vale: Ignore :class: inline roles
PProfizi Oct 9, 2023
74a5006
Vale: Ignore :meth: inline roles
PProfizi Oct 9, 2023
460fa6f
Vale: Ignore :py:class: and :py:meth: inline roles
PProfizi Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-style.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ jobs:
files: docs
reporter: ${{ inputs.vale_reporter || 'local' }}
level: error
filter_mode: nofilter
filter_mode: added
fail_on_error: true
vale_flags: "--config=docs/.vale.ini"
12 changes: 11 additions & 1 deletion docs/.vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,14 @@ BasedOnStyles = Vale, Google

# Removing Google-specific rule - Not applicable under some circumstances
Google.WordList = NO
Google.Colons = NO
Google.Colons = NO

[formats]
# Format associations appear under
# the optional "formats" section.

[*]
# Format-specific settings appear
# under a user-provided "glob"
# pattern.
TokenIgnores = (:class:\x60.*\x60|:meth:\x60.*\x60|:py:class:\x60.*\x60|:py:meth:\x60.*\x60)
5 changes: 2 additions & 3 deletions docs/source/user_guide/operators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,9 +279,8 @@ This example instantiates operators with other operators:
min_max = ops.min_max.min_max(displacement)

This automatically connects the matching ``displacement`` output with the
matching ``min_max`` input. You can also use the :py:meth:`connect()
<ansys.dpf.core.dpf_operator.Operator.connect>` method to manually connect
the outputs of one operator to the inputs of another operator:
matching ``min_max`` input. You can also use the :py:meth:`connect()<ansys.dpf.core.dpf_operator.Operator.connect>`
method to manually connect the outputs of one operator to the inputs of another operator:

.. code-block:: python

Expand Down