Disable doc generation when AUTOMETRICS_DISABLE_DOCS env var is present #104
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
arendjr
reviewed
May 26, 2023
autometrics-macros/src/lib.rs
Outdated
| // Build the documentation we'll add to the function's RustDocs | ||
| let metrics_docs = create_metrics_docs(&prometheus_url, &function_name, args.track_concurrency); | ||
| // Build the documentation we'll add to the function's RustDocs, unless it is disabled by the environment variable | ||
| let metrics_docs = if option_env!("AUTOMETRICS_DISABLE_DOCS").is_some() { |
There was a problem hiding this comment.
option_env! works at compile-time. Is that really what we want? I see PROMETHEUS_URL uses the regular env::var() function, which I think I would've expected here too.
There was a problem hiding this comment.
TBH, I'm not sure it makes a difference because the macros are only run at compile time. But I can change it anyway
There was a problem hiding this comment.
Yeah, I also found it hard to reason about what it means for something to be done at compile-time for a macro. Maybe avoiding the confusion is reason enough :)
arendjr
approved these changes
May 26, 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.
Resolves #80