Fix English issues in the documentation #4649
Conversation
One of the implemented rules is: > A compound adjective usually gets a hyphen when it comes before a > noun.
This seems to be a compound adjective which usually gets a hyphen.
Refer to https://en.wikipedia.org/wiki/Proper_noun#Modern_English_capitalization_of_proper_nouns. > In modern English orthography, it is the norm for recognized proper > names to be capitalized.
|
The first commit contains the obvious things which are likely to be OK without a debate. It can be cherry-picked and merged separately to avoid merge conflicts with other branches. |
| @@ -1033,7 +1033,7 @@ either as separate arguments to the | |||
| &f-Clean; | |||
| method, or as a list. | |||
| &f-Clean; | |||
| will also accept the return value of any of the &consenv; | |||
| will also accept the return value of the &consenv; | |||
| @@ -1065,7 +1065,7 @@ Clean(['foo', 'bar'], 'something_else_to_clean') | |||
| In this example, | |||
| installing the project creates a subdirectory for the documentation. | |||
| This statement causes the subdirectory to be removed | |||
| if the project is deinstalled. | |||
| if the project is uninstalled. | |||
SCons/Tool/ninja/ninja.xml
Outdated
| @@ -350,15 +350,15 @@ python -m pip install ninja | |||
| <summary> | |||
| <para> | |||
| Internal value used to specify the function to call with argument env to generate the list of files | |||
| which if changed would require the &ninja; build file to be regenerated. | |||
| which -- if changed -- would require the &ninja; build file to be regenerated. | |||
There was a problem hiding this comment.
not super fond of double dashes as separators, though that may be only a personal bias.
There was a problem hiding this comment.
Can also use parentheses instead if that gets this PR going.
There was a problem hiding this comment.
proper grammar would be which, if changed, would...
| @@ -40,7 +40,7 @@ | |||
| This paper has introduced &SCons;, a next-generation build tool | |||
| with a modular, embeddable architecture and a direct Python | |||
| interface. &SCons; has a global view of the dependencies in a source | |||
| tree, uses MD5 signatures to decide if derived files are out of date, | |||
There was a problem hiding this comment.
this file is "unmaintained" - doesn't hurt to fix this, but it has worse problems.
|
In general, this looks good to me, not just fixing typos but improving consistency. The one question would be whether our esteemed maintainer indeed prefers normalizing on "out-of-date" instead of "out of date" (I'm fine with that change). |
|
@rico-chet - you should also add a blurb in RELEASE.txt and CHANGES.txt per the checklist at the top. |
…ity instead of the word tool
|
Made a bunch of edits, added CHANGE/RELEASE.txts I'll go ahead an merge. If you can let me know your actual name we can update the CHANGES.txt blurb for this PR. |
My actual name is Alex Thiessen, and it did cost me a few hours of spare time to bring it in. I use SCons at work, find it underappreciated, and am glad to give something back. |
|
@rico-chet - updated CHANGES.txt - Thanks for your help! |
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).The change is probably too minor to check any of the boxes above.
Addresses #4635