Add SemanticVersion to API docs #7003
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add additional method docs
Sija
reviewed
Oct 28, 2018
|
Sorry, I was thinking about dash, like in the examples you've given. |
wooster0
suggested changes
Oct 29, 2018
src/semantic_version.cr
Outdated
| @@ -47,21 +71,31 @@ class SemanticVersion | |||
| end | |||
| end | |||
|
|
|||
| # :nodoc: | |||
There was a problem hiding this comment.
Why :nodoc:? The <=> comparison operator should be documented so users know it can be used here.
Suggested change
| # :nodoc: | |
| # The comparison operator. | |
| # | |
| # ``` | |
| # require "semantic_version" | |
| # | |
| # semver1 = SemanticVersion.new(1, 0, 0) | |
| # semver2 = SemanticVersion.new(2, 0, 0) | |
| # semver1 <=> semver2 # => -1 | |
| # ``` |
There was a problem hiding this comment.
Was thinking since its required by the Comparable that the user would look there.
But probably wouldn't hurt to add here as well.
src/semantic_version.cr
Outdated
| def to_s(io : IO) | ||
| identifiers.join(".", io) | ||
| end | ||
|
|
||
| # :nodoc: |
src/semantic_version.cr
Outdated
| @@ -23,6 +40,7 @@ class SemanticVersion | |||
| end | |||
| end | |||
|
|
|||
| # Create a new `SemanticVersion` instance with the given major, minor, and patch versions | |||
There was a problem hiding this comment.
Suggested change
| # Create a new `SemanticVersion` instance with the given major, minor, and patch versions | |
| # Creates a new `SemanticVersion` instance with the given major, minor, and patch versions | |
| # and optionally build and pre-release metadata | |
| # | |
| # Raises `ArgumentError` if *prerelease* is invalid pre-release metadata. |
src/semantic_version.cr
Outdated
| getter identifiers : Array(String | Int32) | ||
|
|
||
| # Create a new `Prerelease` instance with supplied array of identifiers |
There was a problem hiding this comment.
Use the third person: Creates.
src/semantic_version.cr
Outdated
| getter patch : Int32 | ||
|
|
||
| # The build number of this semantic version |
There was a problem hiding this comment.
It's not always just a number.
Suggested change
| # The build number of this semantic version | |
| # The build metadata of this semantic version |
wooster0
approved these changes
Oct 29, 2018
bcardiff
approved these changes
Oct 29, 2018
RX14
reviewed
Oct 30, 2018
src/semantic_version.cr
Outdated
| getter build : String? | ||
|
|
||
| # The pre-release metadata of this semantic version |
There was a problem hiding this comment.
semver.org calls this the pre-release version
wooster0
reviewed
Oct 30, 2018
src/semantic_version.cr
Outdated
| @@ -23,6 +43,10 @@ class SemanticVersion | |||
| end | |||
| end | |||
|
|
|||
| # Creates a new `SemanticVersion` instance with the given major, minor, and patch versions | |||
| # and optionally build and pre-release metadata | |||
There was a problem hiding this comment.
Here and below are still some pre-release metadata instances.
RX14
approved these changes
Oct 30, 2018
|
Anything else need done on this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SemanticVersiontodocs_main.crto include it in doc generation.SemanticVersionclass.Resolves #6999