Document the fields of VersionNumber
#50179
Merged
Conversation
This file contains hidden or 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
Member
|
I believe immutability allows for better compile time comparisons. Is there a case where there's a length greater than 1? |
Member
Author
|
Yes, the two fields can have any number of prerelease or build tags separated by a comma. |
giordano
reviewed
Nov 1, 2023
test/version.jl
Outdated
| end | ||
|
|
||
| # banner | ||
| import Base.banner |
Member
There was a problem hiding this comment.
This doesn't exist anymore on master
Member
Author
There was a problem hiding this comment.
Must have been a rebasing problem. Fixed, thanks!
`VersionNumber`'s fields are currently not documented, and therefore, private by default. However, if people want to use `VersionNumber` for anything other than the documented comparison operations, users will have to access the fields.
jakobnissen
force-pushed
the
vnum_docs
branch
from
3360631 to
c2155af
Compare
Member
Author
|
OK - rebased and ready.
|
topolarity
reviewed
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
VersionNumber's fields are currently not documented, and therefore, private by default.However, if people want to use
VersionNumberfor anything other than the documented comparison operations, users will have to access the fields.Questions for reviewers
Do we want this? Normally, fields are not documented for a reason. But I feel like it's hard to use
VersionNumberfor much in practice without access to its fields, unless we add several more methods such asmajor(::VersionNumber)etc.Should we change the field type of
.prereleaseand.buildfromTuple{Vararg{T}}toVector{T}? It seems like it was changed fromVectortoTuplein ef69a19 to make VersionNumber immutable. I'm not sure why that's a good thing, since it currently means accessing.prereleaseis type unstable but there might be a good reason.