search

adobe / hyde

A front-end to Jekyll that parses C++ sources to produce and enforce out-of-line documentation
http://opensource.adobe.com/hyde/
MIT License
323 stars 41 forks source link

docs: Corrected some missed punctuation #45

Closed leeclench closed 4 years ago

leeclench commented 4 years ago

Added missing punctuation and capitalisation to a couple of documents to neaten the structure. The following files have been amended: README.md (Added missing punctuation/capitalisation). CODE_OF_CONDUCT.md (Added missing punctuation). docs/index.html (Capitalised subscribe at the bottom of the document). .github/ISSUE_TEMPLATE/bug_report.md (Added missing punctuation). generate_test_files.sh (Added a space to the comment).

These changes break nothing and mearly neaten the structure of the files.

jaredwy commented 4 years ago

Hi @leeclench thanks for the PR.

As some of these files are to be used standard across adobe projects, we won't want to update them just for this repo.

These include the code of conduct and the issue template.

The addition to the ones in the readme.MD also don't make much sense as they are not complete sentences just examples or fragments.

If you want to update the PR to include the .sh file and any others that make sense in the readme then we can look to merge this.

leeclench commented 4 years ago

Hi @leeclench thanks for the PR.

As some of these files are to be used standard across adobe projects, we won't want to update them just for this repo.

These include the code of conduct and the issue template.

The addition to the ones in the readme.MD also don't make much sense as they are not complete sentences just examples or fragments.

If you want to update the PR to include the .sh file and any others that make sense in the readme then we can look to merge this.

The base templates were updated last week. This is just bringing them up to current standard.