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

Corrected english mistakes in documentation files #151

Merged
merged 3 commits into from
Jul 22, 2024

Conversation

amishgog
Copy link
Contributor

Hello Mr Jiangi Yi,

I have been running partial wave analysis using your since I found it to be very easy to use. My advisor Dr. Yunxuan Song recommended me to use your package. I noticed in the documentation that there are many spelling errors. Since I liked your package I wanted to take the time to improve your documentation.

I have made several changes to the .rst files

Thank you

@jiangyi15
Copy link
Owner

Thanks for you contribution. There are some errors in the style checks, can you fix it?

There are two things,

  • The under line of titles should have the same lengnth of titles.
  • Rename the file if you change in the toc.

You can check the style using pre-commit.

@@ -20,7 +20,7 @@ A detailed configuration file sample (with all usable parameters) can be found *
amplitude
custom_model
decay_topology
resonacnes_params
Copy link
Owner

Choose a reason for hiding this comment

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

It is the filename of rst.
git mv resonacnes_params.rst resonances_params.rst

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ohh, sorry yes I have changed the filename

@amishgog amishgog changed the title Correctly english mistakes in documentation files Corrected english mistakes in documentation files Jul 22, 2024
@jiangyi15 jiangyi15 merged commit 07d25ce into jiangyi15:dev Jul 22, 2024
11 checks passed
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.

2 participants