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

Fix punctuation, capitalization and spelling in documentation #384

Closed
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
2 participants
@ianbollinger
Contributor

ianbollinger commented Sep 1, 2015

Fix a few typos and a few other orthographic mistakes.

ianbollinger added some commits Sep 1, 2015

Fix spelling/capitalization of various words
Fix spelling of:

* arithmetic
* arranged
* associated
* implementation
* primarily
* explicitly
* menu

Capitalize proper nouns:

* Unicode
* Cartesian

Capitalize initialisms:

* JSON
* URL
* GIF
Time stamp is two words
At least, it is according to my dictionary.
@evancz

This comment has been minimized.

Show comment
Hide comment
@evancz

evancz Sep 2, 2015

Member

Can you split the spelling out into its own PR, those are all fine.

I don't think the other stuff is as clear. For example, timestamp can be used as one word. With the capitalization stuff as well, I think a lot of that varies based on usage.

Looks like Cartesian should be caps (evidence) but there are others that are less certain. Smaller PRs make it easier to figure out. If you can do a small change and say on what grounds is it "better English" then it'll be easier to change. For example, Json is a specific thing within Elm, and it handles JSON values. Not sure which is more appropriate.

Member

evancz commented Sep 2, 2015

Can you split the spelling out into its own PR, those are all fine.

I don't think the other stuff is as clear. For example, timestamp can be used as one word. With the capitalization stuff as well, I think a lot of that varies based on usage.

Looks like Cartesian should be caps (evidence) but there are others that are less certain. Smaller PRs make it easier to figure out. If you can do a small change and say on what grounds is it "better English" then it'll be easier to change. For example, Json is a specific thing within Elm, and it handles JSON values. Not sure which is more appropriate.

@evancz evancz closed this Sep 2, 2015

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