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
Minor formatting/markup tweaks #301
base: master
Are you sure you want to change the base?
Conversation
(I believe this is a patch-level change. :P)
@@ -327,7 +330,7 @@ The Semantic Versioning specification is authored by [Tom | |||
Preston-Werner](http://tom.preston-werner.com), inventor of Gravatars and | |||
cofounder of GitHub. | |||
|
|||
If you'd like to leave feedback, please [open an issue on | |||
If you'd like to leave feedback, please [open an Issue on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is "Issue" being capitalized?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It shouldn't be.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was considering “Issues” a proper noun (as in “GitHub Issues”). Will change back to lowercase.
As per [comment](https://github.com/mojombo/semver/pull/301/files/08d32de1fbb01235c38c4ba299b7aa04f90665d2#r60998922) on my original Pull Request.
De-capitalized “issue”. :) |
ping |
@@ -4,15 +4,15 @@ Semantic Versioning 2.0.0 | |||
Summary | |||
------- | |||
|
|||
Given a version number MAJOR.MINOR.PATCH, increment the: | |||
Given a version number `MAJOR.MINOR.PATCH`, increment the: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The quotes are not needed around MAJOR.MINOR.PATCH and seem to be confusing. The all-caps seems to be sufficient.
|
||
1. MAJOR version when you make incompatible API changes, | ||
1. MINOR version when you add functionality in a backwards-compatible | ||
1. `MAJOR` version when you make incompatible API changes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why isn't all-caps sufficient?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would deny these changes. They degrade the clarity of the document.
Closing & re-opening to trigger CI |
I agree that this doesn't add clarity. |
I'm actually okay with wrapping with backticks examples of versions like |
Adjust RFC keywords in zh-TW
(I believe this is a patch-level change. :P)