Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Registry::register should not automatically append a period to the help text #56

Closed
08d2 opened this issue Mar 25, 2022 · 2 comments
Closed

Comments

@08d2
Copy link

08d2 commented Mar 25, 2022

Help strings should end with a period, per Prometheus guidance. But if a user does that themselves, the help string will be incorrect, as "a full stop punctuation mark (.) is automatically added to the passed help text" given to Registry::register.

Probably the best solution here is to append the period only if it doesn't already exist.

@mxinden
Copy link
Member

mxinden commented Mar 25, 2022

Added to #52. Thanks @08d2. Let me know in case you want to tackle any of these.

@mxinden mxinden closed this as completed Mar 25, 2022
@08d2
Copy link
Author

08d2 commented Mar 26, 2022

I'm suggesting that help strings should be allowed to end in periods without that resulting in .. on scrape. Happy to PR if that's what it takes 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants