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.

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

Fix vale warnings #2139

Merged
merged 4 commits into from Oct 13, 2023
Merged

Fix vale warnings #2139

merged 4 commits into from Oct 13, 2023

Conversation

mkundu1
Copy link
Contributor

@mkundu1 mkundu1 commented Oct 13, 2023

These warnings started appearing in multiple PRs - https://github.com/ansys/pyfluent/actions/runs/6505185628/job/17668355789?pr=2136#step:6:63

Some of these warnings seem false-positive. Why does Import geometry raise a warning, but Describe geometry does not?

@raph-luc
Copy link
Member

raph-luc commented Oct 13, 2023

Could it be that it wants us to write something like Import the geometry?

Edit: never mind, there are other false positives such as 'Launching Fluent' should use sentence-style capitalization. which makes no sense as Fluent is already defined in the vocabulary for Vale.

I think it is indeed best to just disable this check for now.

@mkundu1
Copy link
Contributor Author

mkundu1 commented Oct 13, 2023

Could it be that it wants us to write something like Import the geometry?

The rule is in the google link mentioned in https://github.com/errata-ai/Google/blob/master/Google/Headings.yml. Funnily it shows the warning also for Capitalization in titles and headings from the google page.

@hpohekar
Copy link
Collaborator

Why does Import geometry raise a warning, but Describe geometry does not? - yes, it is strange.

Following are seems to be correct.

TUI is not listed in accept.txt

Use solver TUI commands -
Solver TUI commands
Use solver TUI commands

@mkundu1 mkundu1 closed this Oct 13, 2023
@mkundu1 mkundu1 reopened this Oct 13, 2023
@raph-luc
Copy link
Member

@hpohekar That is a good point, not all of the warnings are false-positives, but there are way too many false-positives currently for us to keep it active. Even stuff like 'Journaling' should use sentence-style capitalization., what does it even expect us to do? I have no idea.

@hpohekar
Copy link
Collaborator

@hpohekar That is a good point, not all of the warnings are false-positives, but there are way too many false-positives currently for us to keep it active. Even stuff like 'Journaling' should use sentence-style capitalization., what does it even expect us to do? I have no idea.

Yes, I agree. No idea.

.vale.ini Show resolved Hide resolved
@raph-luc raph-luc mentioned this pull request Oct 13, 2023
@mkundu1 mkundu1 linked an issue Oct 13, 2023 that may be closed by this pull request
@mkundu1 mkundu1 merged commit 9d11b0b into main Oct 13, 2023
19 checks passed
@mkundu1 mkundu1 deleted the fix/vale branch October 13, 2023 19:41
raph-luc pushed a commit that referenced this pull request Oct 25, 2023
* Fix vale warnings

* Accept some strings in doc

* Temporarily skipping rpvar tests till the docker image is updated

* Mark some tests to require codegen
raph-luc added a commit that referenced this pull request Oct 26, 2023
* Fix vale warnings (#2139)

* fix tensor type for displacement variable (#2145)

* Fix set_state implementation for command argument instance. (#2147)

* Update flobject.py (#2148)

* SVAR Doc (#1635)

* Test to catch Watchdog launch errors, and improved Watchdog behavior on Windows (#2144)

* Cavitation Model Example And Example Warning Fix (#2102)

* Add type annotations for some modules under services (#2108)

* More robust Windows launch command for Watchdog (#2167)

* Making h5py an optional dependency, not installed by default (#2171)

* Expose settings root like in pyconsole. (#2149)

* Remove timeout loop in FluentConnection (#2126)

* Fix SVAR doc (#2172)

---------

Co-authored-by: Mainak Kundu <94432368+mkundu1@users.noreply.github.com>
Co-authored-by: Oleg Chernukhin <92750311+ochernuk@users.noreply.github.com>
Co-authored-by: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com>
Co-authored-by: Harshal Pohekar <106588300+hpohekar@users.noreply.github.com>
Co-authored-by: Aseem Jain <95020968+ajain-work@users.noreply.github.com>
Co-authored-by: Prithwish Mukherjee <prithwish.mukherjee@ansys.com>
Co-authored-by: Adam Boutin <143635850+ansaboutin@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.

24R1 tests are failing
4 participants