sadpandajoe commented on code in PR #45467:
URL: https://github.com/apache/superset/pull/45467#discussion_r4328481094
##########
docs/developer_docs/api.mdx:
##########
@@ -128,6 +128,10 @@ update preserves the stored secrets; send new values to
replace them.
| `GET` | [Get related fields data
(chart-related-column-name)](/developer-docs/api/get-related-fields-data-chart-related-column-name)
| `/api/v1/chart/related/{column_name}` |
| `PUT` | [Warm up the cache for the
chart](/developer-docs/api/warm-up-the-cache-for-the-chart) |
`/api/v1/chart/warm_up_cache` |
+Chart-data `compare` post-processing handles zero baselines consistently for
raw SQL
+`DECIMAL` columns and floating-point inputs in percentage and ratio
comparisons.
+Absolute-difference comparisons retain the input arithmetic.
Review Comment:
`docs/developer_docs/api.mdx` is regenerated wholesale by
`docs/scripts/generate-api-index.mjs` (it writes `OUTPUT_PATH` with
`fs.writeFileSync`), so the next `generate:api-docs` or docs build will drop
this paragraph and leave nothing documenting the behavior. It also sits inside
the Charts endpoint `<details>` block, after the table, where it doesn't
describe an endpoint. Would you move it to a hand-written page (or the
`compare` operation's description in the OpenAPI source) instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
