You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The formatting of the documentation for the function get_metric_aggregation appears to be broken as ilustrated below:
The description for the parameter query contains a link, which I suspect is causing the issue but I am unable to build the documentation to verify myself.
Please note the use of single ` to surround the link text and link itself. Also the addition of <> to surround the link itself and followed by a trailing _.
I would be happy to make the necessary amendments but would need some guidance on how to build the docs.
The text was updated successfully, but these errors were encountered:
miah0x41
changed the title
Documentation Broken: get_metric_aggregation
Documentation Broken: get_metric_aggregation and MetricRangeDataFrameDec 30, 2023
However MetricRangeDataFrame only works on ranges and therefore prom.get_current_metric_value is the wrong function, should be I think: get_metric_range_data (well possibly).
The formatting of the documentation for the function
get_metric_aggregation
appears to be broken as ilustrated below:The description for the parameter
query
contains a link, which I suspect is causing the issue but I am unable to build the documentation to verify myself.I think these are the responsible lines:
https://github.com/4n4nd/prometheus-api-client-python/blob/49362b07cb3bec835a8211d81becd5ed205ace18/prometheus_api_client/prometheus_connect.py#L466C1-L467C77
The link formatting for
rst
should be I believe:Please note the use of single
`
to surround the link text and link itself. Also the addition of<>
to surround the link itself and followed by a trailing_
.I would be happy to make the necessary amendments but would need some guidance on how to build the docs.
The text was updated successfully, but these errors were encountered: