brutasse / graphite-api

Graphite-web, without the interface. Just the rendering HTTP API.
https://graphite-api.readthedocs.io
Apache License 2.0
492 stars 131 forks source link

Docs improvement #229

Open za3k opened 6 years ago

za3k commented 6 years ago

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 commented 6 years ago

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?