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

DOC: Fix toc in documentation and a typo #255

Merged
merged 3 commits into from
Sep 2, 2024

Conversation

avirsaha
Copy link
Contributor

@avirsaha avirsaha commented Sep 1, 2024

Closes #251

Copy link
Owner

@neutrinoceros neutrinoceros left a comment

Choose a reason for hiding this comment

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

Hi @avirsaha, thanks for your contribution !
Can you please revert the change of style in bullet (* -> -) ? Other than that, looks good to me !

@neutrinoceros
Copy link
Owner

Also note that I normally generate (and update) this table of contents with a pre-commit hook, it just happens to be commented at the moment, but I think it can be uncommented now (see https://github.com/neutrinoceros/gpgi/blob/main/.pre-commit-config.yaml#L21). If you feel like it, you can also uncomment it here, but it's fine if you don't !
Thanks again !

@neutrinoceros neutrinoceros added the documentation Improvements or additions to documentation label Sep 1, 2024
@neutrinoceros neutrinoceros added this to the v2.0.0 milestone Sep 1, 2024
@avirsaha
Copy link
Contributor Author

avirsaha commented Sep 2, 2024

Thank you for your review and valuable feedback. I'll make the necessary changes.

@avirsaha
Copy link
Contributor Author

avirsaha commented Sep 2, 2024

The necessary changes to the TOC style have been made, and I've also uncommented the pre-commit hook you mentioned earlier.

@neutrinoceros neutrinoceros changed the title Fix toc in documentation and typo. DOC: Fix toc in documentation and a typo Sep 2, 2024
@neutrinoceros
Copy link
Owner

Thank you again !

@neutrinoceros neutrinoceros merged commit 81082ff into neutrinoceros:main Sep 2, 2024
17 checks passed
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.

DOC: table of contents is out of sync
2 participants