Docs: add description_method struct tag support #3064
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
Signed-off-by: Marco Pracucci <marco@pracucci.com>
Signed-off-by: Marco Pracucci <marco@pracucci.com>
pstibrany
approved these changes
Sep 28, 2022
Signed-off-by: Marco Pracucci <marco@pracucci.com>
pracucci
changed the title
👍 Done in c1914ac |
sysedwinistrator
pushed a commit
to sysedwinistrator/mimir
that referenced
this pull request
Nov 21, 2022
* Docs: add description_func struct tag support Signed-off-by: Marco Pracucci <marco@pracucci.com> * Revert rename to make diff easier Signed-off-by: Marco Pracucci <marco@pracucci.com> * Renamed description_func to description_method Signed-off-by: Marco Pracucci <marco@pracucci.com> Signed-off-by: Marco Pracucci <marco@pracucci.com>
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.
What this PR does
Me and @bboreham had a conversation about the long help text that will be produced by grafana/dskit#217. We both agree that having it in the markdown is fine, but in the
-helpoutput is not that nice. So, in this PR I'm introducing a way to specify the auto-generated doc description via function too, so that we can use it in grafana/dskit#217.To show how it works, I've applied to the GCS service account description, which was one of our few cases with a multi line description.
Which issue(s) this PR fixes or relates to
N/A
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]