Add support for ignoring/deleting generated links #41
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
The generator takes an extra argument, through command-line or environment variable, that allows to opt-out of documentation generation. There is also the possibility to opt-in this deactivation on a per-function basis, using the `--no-doc` argument on the directive. This also changes the name of the directive, from `autometrics:doc` to `autometrics:inst`, as now the directive doesn't always add documentation to the functions it instruments. For backwards compatibility, the `doc` attribute is still accepted, and will be removed in a later version. Closes #38
|
For the time being, the flag is @arendjr @emschwartz Are there implementations that already use different names for those? That's probably a good time to change those names, in the Go implementation at least, to be uniform if that's important Also, this PR probably needs to be merged after #40, and at that point I'll also add the changelog modifications to the PR here |
mellowagain
approved these changes
May 11, 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.
The generator takes an extra argument, through command-line or
environment variable, that allows to opt-out of documentation
generation. There is also the possibility to opt-in this deactivation on
a per-function basis, using the
--no-docargument on the directive.This also changes the name of the directive, from
autometrics:doctoautometrics:inst, as now the directive doesn't always adddocumentation to the functions it instruments. For backwards
compatibility, the
docattribute is still accepted, and will beremoved in a later version.
Closes #38