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

Cleanup of the schemas #33

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

logicplace
Copy link

@logicplace logicplace commented Jul 27, 2020

The first commit here normalizes all the code formatting, such as indentation and putting one-line paragraphs on the same line as their opening and closing p tags. This commit also fixes some typos in like some HTML comments but no where else. I made one choice here that was against the common styling of the document, in that I indented all the contents of the pre tags.

The following three commits fix typos, grammar errors, inconsistencies wrt oxford comma (I removed them all, since that seemed to be more common), and errors in the examples. I did my best to keep to British English, of course.

If some part of this is unwanted let me know, I can adjust.

Link to review content changes only

@adamretter
Copy link
Contributor

Thanks @logicplace this looks good :-)

@DavidUnderdown What do you think?

@DavidUnderdown
Copy link
Contributor

I've had a quick look, but unfortunately GitHub's diff seems to be struggling a bit with rendering the first commit in a useful way. I'm a bit snowed under at the moment and I think that could do with a bit more of a thorough review to ensure that nothing has been inadvertently changed that has semantic meaning.

On the typos/spelling and grammar, most are fine, though I would note that British English has tended to drop the use of full stops (periods) in contractions/abbreviations so eg and ie are fairly normal, rather than e.g. and i.e. (it avoids, for example deciding if you should have two full stops here where such a contraction is used at the end of a sentence). If we're to change these at all it would probably be best to actually go the whole way and follow quite a lot of current style guides and use "for example" and "that is" which are said to be easier for many non-native speakers to comprehend.

@logicplace
Copy link
Author

logicplace commented Jul 28, 2020

To see only content changes from the first commit, which should still only be formatting related except for a few comments with a typo, you can use this link

Good to know about those acronyms, both were used so I wasn't sure. I can switch them all to English when I get a chance, should be easy.

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

3 participants