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

two small typos and a suggestion #5

Merged
merged 3 commits into from
Nov 30, 2023
Merged

two small typos and a suggestion #5

merged 3 commits into from
Nov 30, 2023

Conversation

SwitWu
Copy link
Contributor

@SwitWu SwitWu commented Nov 30, 2023

Since \postnotes isn't actually a command provided by this package, I changed the \cs{postnotes} into postnotes.

@gusbrs
Copy link
Owner

gusbrs commented Nov 30, 2023

Hi @SwitWu , I'm glad you are having fun with the docs. :-)

Since \postnotes isn't actually a command provided by this package, I changed the \cs{postnotes} into postnotes.

True. But I think \cs{postnote}s would be slightly better here.

Also, while fixing the typos is of course much welcome, I think the "Implementation" section is a bit overkill for the User manual. Separating the implementation documentation from that aimed at regular users is a common practice. So much so that it is expected that advanced users are familiar with it, and also know where to find the code documentation if they want to. On the other hand, including a section for this purpose in the User manual hints regular users that the manual is not sufficient for them, which hopefully is not the case.

So, could you please review these two things before I merge?

And, thank you once again!

@SwitWu
Copy link
Contributor Author

SwitWu commented Nov 30, 2023

OK! I agree with your comments.

@SwitWu
Copy link
Contributor Author

SwitWu commented Nov 30, 2023

So, could you please review these two things before I merge?

I have modified the PR.

@gusbrs gusbrs merged commit 1146243 into gusbrs:main Nov 30, 2023
2 checks passed
@gusbrs
Copy link
Owner

gusbrs commented Nov 30, 2023

I have modified the PR.

Merged. Thank you!

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.

None yet

2 participants