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

[#1375] Fix minor documentation inconsistencies in the User Guide and Developer Guide #1376

Conversation

rolandyuwy
Copy link
Contributor

@rolandyuwy rolandyuwy commented Dec 17, 2020

Fixes #1375

Courtesy of @kkangs0226 for spotting these mistakes. 👍
I have taken time to find and fix additional typos and errors explained below:

Screenshots depict current bugs before fixing.
1) Standardize capitalization of instructions and explanations.
image
image

2) Fix formatting (bolding) issues.
image

3) Correct typos.
image
image

4) Standardize hyperlinking of sections.
image

Proposed commit message:

Current User Guide and Developer Guide contains several 
inconsistencies such as typos, grammatical errors and lack of 
standardization amongst sections.

Fixing these bugs will improve readability of these documentation.

Let's,
* standardize capitalization of instructions and explanations
* fix formatting issues
* correct typos
* standardize hyperlinking of sections  

Copy link
Contributor

@Tejas2805 Tejas2805 left a comment

Choose a reason for hiding this comment

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

Left some comments!

docs/ug/generatingReports.md Outdated Show resolved Hide resolved
docs/ug/cli.md Outdated Show resolved Hide resolved
fzdy1914 and others added 3 commits December 18, 2020 17:55
Co-authored-by: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com>
Co-authored-by: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com>
@rolandyuwy
Copy link
Contributor Author

Left some comments!

Changes have been made, thank you!

Copy link
Contributor

@Tejas2805 Tejas2805 left a comment

Choose a reason for hiding this comment

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

One last nit. Rest LGTM!

docs/ug/cli.md Outdated Show resolved Hide resolved
@jamessspanggg
Copy link
Contributor

seems like there is another PR #1379 that fixes the same thing, I think we should stick with one PR to fix these inconsistencies

@fzdy1914
Copy link
Member

fzdy1914 commented Dec 24, 2020

@rolandyuwy Do you agree that @kkangs0226 is the main contributor? If so, I will let @kkangs0226 merge your changes to #1379 and also mention that you are a co-author.

@fzdy1914
Copy link
Member

@rolandyuwy Do you agree that @kkangs0226 is the main contributor? If so, I will merge your changes to #1379 and also mention that you are a co-author.

If so, please also provide your co-author detail like below:

Co-authored-by: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com>
Co-authored-by: WANG CHAO <1229983126@qq.com>

@fzdy1914
Copy link
Member

fzdy1914 commented Jan 2, 2021

Close due to #1396

@fzdy1914 fzdy1914 closed this Jan 2, 2021
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.

Some typos, grammatical errors and inconsistencies in the User Guide and Developer Guide
4 participants