aaron-ang opened a new pull request, #19367:
URL: https://github.com/apache/datafusion/pull/19367

   ## Which issue does this PR close?
   
   - Part of #16602
   
   ## Rationale for this change
   
   ## What changes are included in this PR?
   
   Implemented auto-generated metrics documentation.
   
   ### Macros
   On a metric struct: `#[metrics_doc]` and `#[metrics_doc(common)]` (marks 
common/shared metrics). It auto-derives DocumentedMetrics and captures 
struct/field doc comments. Skip a field with `#[metrics_doc_attr(skip)] `.
   
   On an exec struct: `#[metrics_doc(MetricA, MetricB)]` lists the metrics 
types it exposes. It auto-derives DocumentedExec and links to those metrics 
docs.
   
   The docs are collected in `metrics_docs.rs` and generated in 
`print_metric_docs.rs`.
   
   ## Are these changes tested?
   
   Yes, by running `dev/update_metrics_docs.sh`.
   
   ## Are there any user-facing changes?
   
   <!--
   If there are user-facing changes then we may require documentation to be 
updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please add the `api 
change` label.
   -->
   


-- 
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]

Reply via email to