StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #479 from amanvell/patch-2

Browse Source 
Minor spelling/grammar correction
This commit is contained in:
Tony Ruscoe 2019-10-08 10:13:52 +01:00 committed by GitHub
commit 55b15d1b95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docguide/best_practices.md
View File

@ -57,7 +57,7 @@ docs are in bad shape:
## Prefer the good over the perfect ## Prefer the good over the perfect
Your documentation should be as good as possible within a reasonable time frame. Your documentation should be as good as possible within a reasonable time frame.
The standards for an documentation review are different from the The standards for a documentation review are different from the
standards for code reviews. Reviewers can and should ask for improvements, but standards for code reviews. Reviewers can and should ask for improvements, but
in general, the author should always be able to invoke the "Good Over Perfect in general, the author should always be able to invoke the "Good Over Perfect
Rule". It's preferable to allow authors to quickly submit changes that improve Rule". It's preferable to allow authors to quickly submit changes that improve