feat(graindoc)!: Add --current-version flag, required for since/history attributes
#1116
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
phated
changed the title
--current-version flag, required for since/history attributes
peblair
reviewed
Jan 22, 2022
| @@ -11,6 +11,27 @@ type t = { | |||
| attributes: list(Comments.Attribute.t), | |||
| }; | |||
|
|
|||
| exception | |||
| MissingFlag({ | |||
There was a problem hiding this comment.
I'm a bit confused -- why do we require the flag? Can we not infer a default from the compiler version?
There was a problem hiding this comment.
Compiler version doesn't work when external libraries authors are using Grain doc. Their @since and @history will be specific to their development workflows and library version.
|
Maybe we'll be able to do something fun in the future with the |
Closed
Closed
Merged
This was referenced Mar 20, 2023
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.
Closes #1110
This adds a
--current-versionflag to thegrain doccommand line. If your docs are using@sinceor@history, this flag is required (thus breaking) because we need (want?) a version to compare so we can insertnextinto the generated markdown if the docs are being generated before a release is made.