docs: add pre option for inc
#570
Closed
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
Adds description of using `pre` with `inc` function with caveat that it might lead to unexpected results if version does not include a pre-release. ## References Closes npm#124
|
Line 247 in e7b78de I think we shouldn't call attention to this or suggest using it. It's a very much internal tool. |
|
Hmm. The pre option always has been and still is a public feature. Most certainly it's used as well since it provides a useful function that is otherwise not available. (I would also say Issac agreed with documenting it in the referenced issue but didn't get to it). |
|
Perhaps it needs a bigger disclaimer then, it is definitely a method that does not work how one would expect. |
|
Maybe better to remove the option to call |
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.
Adds description of using
prewithincfunction with caveat that it might lead to unexpected results if version does not include a pre-release.References
Closes #124