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

Docs improvement #229

Open
za3k opened this issue Oct 26, 2017 · 1 comment
Open

Docs improvement #229

za3k opened this issue Oct 26, 2017 · 1 comment

Comments

@za3k
Copy link

za3k commented Oct 26, 2017

On http://graphite-api.readthedocs.io/en/latest/api.html, "Parameters are looked up in the order above". There's no canonical reading of "the order above", so the clarifying example is helpful.

I would suggest reversing the order and changing to "If the same parameter is present in more than one location, the first location listed is used." which is how I see most documentation written.

@brutasse
Copy link
Owner

Sounds good, but no reversing should be needed with your wording: https://github.com/brutasse/graphite-api/blob/master/graphite_api/utils.py#L32-L38 -- I realize the example is wrong, it's the other way around.

Could you submit a PR?

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