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

maint(typos): rename PDF to DPF #1257

Merged
merged 2 commits into from
Nov 9, 2023
Merged

maint(typos): rename PDF to DPF #1257

merged 2 commits into from
Nov 9, 2023

Conversation

awoimbee
Copy link
Contributor

@awoimbee awoimbee commented Nov 9, 2023

Just a small mistake I found in the docs, used rg and rsr to try to fix every misspelling.

BTW in this PR I'm just fixing the project name, but typos finds a lot of mistakes, it might be a good idea to add it to your CI.

Copy link
Contributor

@PProfizi PProfizi left a comment

Choose a reason for hiding this comment

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

Hi @awoimbee, thank you for correcting these typos.
I do not know rg nor rsr, we use flake and codespell in our CI.
The PDF mistakes I guess are due to this word being accepted by default.
As for the rest of the typos, I'll give a try to rg and rsr.
Keep in mind though that a good part of our code is generated by the server and may contain spelling mistakes that this repo has no power over, such as in the ansys.dpf.core.operators module.
Also just proposing two modifications to the corrections you proposed.
Our CI cannot run on forks so I'll merge manually once this is ready.
Thanks!

README.md Outdated Show resolved Hide resolved
docs/source/user_guide/custom_operators_deps.rst Outdated Show resolved Hide resolved
Co-authored-by: Paul Profizi <100710998+PProfizi@users.noreply.github.com>
@awoimbee
Copy link
Contributor Author

awoimbee commented Nov 9, 2023

rg and rsr are only alternatives to grep and sed really, but I think you should try typos, it finds issues in this repo like:
Runn[-n-]i{+n+}g pan[-n-]el instan[-c-]{+t+}iate nu{+m+}ber diction[-n-]ary wor{+k+}flow cum[-m-]ulative_index recombine_harmonic_ind[-e-]{+i+}ces_cyclic Syntax[-e-]Error

@PProfizi
Copy link
Contributor

PProfizi commented Nov 9, 2023

rg and rsr are only alternatives to grep and sed really, but I think you should try typos, it finds issues in this repo like: Runn[-n-]i{+n+}g pan[-n-]el instan[-c-]{+t+}iate nu{+m+}ber diction[-n-]ary wor{+k+}flow cum[-m-]ulative_index recombine_harmonic_ind[-e-]{+i+}ces_cyclic Syntax[-e-]Error

Indeed, I see them. I think most of them are in parts of the code generated by the server, meaning we should improve typo detection there. Thank you! I'll merge the PR.

@PProfizi PProfizi merged commit 98f63eb into ansys:master Nov 9, 2023
@awoimbee awoimbee deleted the aw/typo-pdf-dpf branch November 10, 2023 17:48
@PProfizi PProfizi added the documentation Improvements or additions to documentation label Dec 14, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants