Skip to content

Capitalization, punctuation and spelling fixes - #784

Merged
mlinksva merged 5 commits into
github:gh-pagesfrom
waldyrious:capitalization-punctuation
Nov 14, 2020
Merged

mlinksva merged 5 commits into
github:gh-pagesfrom
waldyrious:capitalization-punctuation

Conversation

@waldyrious

Copy link
Copy Markdown
Contributor
  • Harmonize capitalization in section headings:
    Use "Sentence case" instead of "Title Case", since the former style was more prevalent.
  • Harmonize quotation marks and apostrophes:
    Use straight marks in source files (txt, md) and curly marks in rendered files (html).
  • Fix a typo in the terms of service: "merchantibility" → "merchantability".

@mlinksva

Copy link
Copy Markdown
Contributor

Harmonize quotation marks and apostrophes:
Use straight marks in source files (txt, md) and curly marks in rendered files (html).

What is the rationale for harmonizing on straight marks in source files? I don't feel strongly about that outside of the license texts themselves, but I'd rather not touch those.

The other two changes look good, thanks!

@waldyrious

waldyrious commented Oct 30, 2020 •

Copy link
Copy Markdown
Contributor Author

It's common to limit source files to ASCII-only characters, where possible, to facilitate editing, search/replace operations, avoid potential ambiguities in diffs, etc. I understand that the license texts themselves are not supposed to be edited, but in practice things like typo fixes (case in point!), line wrapping, indentation adjustments, etc. tend to happen, so it's best to keep them text-editor friendly. This is also recommended by style guides such as Google's and Wikipedia's. (As an aside, this article may be an interesting read on this topic.)

By the way: these were pretty much the only non-ASCII characters ([^\x00-\xFF]) in the *.txt and *.md files of this repo. The other exception is dashes, which I'm happy to replace with - or -- as well, since that's another source of inconsistency and ambiguity. For example, currently the only license text that uses dashes is odbl-1.0.txt, which uses – (that's an en-dash, by the way); all others use plain hyphens as - or --; and there are a couple instances of the en-dash in markdown files, but there's a single occurrence of an em-dash (—) in about.md. Everything else is plain ASCII. IMO it would be worth normalizing as well.

@mlinksva

Copy link
Copy Markdown
Contributor

The .html and .md files here each get rendered as HTML. I pushed another commit to use curly throughout, and reverted the license text changes. I'd prefer license text changes get made in https://github.com/spdx/license-list-XML first, and copy what happens there here.

@mlinksva
mlinksva merged commit 50e1c11 into github:gh-pages Nov 14, 2020
@waldyrious
waldyrious deleted the capitalization-punctuation branch November 15, 2020 13:24
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.

3 participants