Support --no-docs-gen argument
#38
Comments
|
It probably needs to be an environment argument, because it's not possible to call When this change is being made, it's also going to be the opportunity to finalize the "directive comment" API, probably as -//autometrics:doc --slo "API" --latency-target 99 --latency-ms 250
+//autometrics:inst [--no-doc] --slo "API" --latency-target 99 --latency-ms 250But undecided yet |
gagbo
added a commit
that referenced
this issue
May 9, 2023
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
gagbo
added a commit
that referenced
this issue
May 11, 2023
* Add support for ignoring/deleting generated links 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The purpose of this argument is to disable documentation generation by the generator. This would allow the VS Code extension to become solely responsible for generating documentation tooltips.
This is a blocker for finalizing autometrics-dev/vscode-autometrics#28
Feel free to suggest a better name for the argument 😅
The text was updated successfully, but these errors were encountered: