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

Revised documentation #1539

Merged
merged 4 commits into from
Jan 3, 2022
Merged

Revised documentation #1539

merged 4 commits into from
Jan 3, 2022

Conversation

hamid-nazari
Copy link
Contributor

I've been studying documentation for past few days and came across some minor issues that I felt would be a pity to let hem slip. Such a great work deserves perfection for all that matters.

Hope these are seen relevant and get pulled in.

Sample code is revised to use `boolean` instead of `String` for `exclusive` annotation attribute
Changed "ore" to "or" in various places
In the context of subcommand aliases, modified statements were referring to "commands" which are changed to "subcommands"
Copy link
Owner

@remkop remkop left a comment

Choose a reason for hiding this comment

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

Wow this is great! Thank you so much!

I found one small improvement in how to phrase the explanation for aliases.
Can you take a look?
If you don't have time to fix that, let me know, I can do it later.

Thank you again! 🙏

docs/index.adoc Outdated Show resolved Hide resolved
docs/index.html Show resolved Hide resolved
docs/man/3.x/index.html Outdated Show resolved Hide resolved
@remkop
Copy link
Owner

remkop commented Jan 3, 2022

@hamid-nazari I saw your feedback, thank you. 🙏
Maybe I am missing something; I see your feedback that you agree this is better, and the conversation is resolved, but I don't see the change reflected in the text. 😅
Will you be able to update your PR, or do you want me to make the changes after merging it?

I've made changes to alleviate ambiguity around "commands" and "subcommands" in the context of aliases
@hamid-nazari
Copy link
Contributor Author

Sorry @remkop,
I got caught up last night and forgot to push my changes

@remkop remkop merged commit 2043891 into remkop:master Jan 3, 2022
remkop added a commit that referenced this pull request Jan 3, 2022
@remkop
Copy link
Owner

remkop commented Jan 3, 2022

Merged.
Thank you for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants