Skip to content

fix(criterion_compat): let benches denying missing_docs compile - #191

Open
LucaCappelletti94 wants to merge 1 commit into
CodSpeedHQ:mainfrom
LucaCappelletti94:upstream/criterion-compat-missing-docs
Open

LucaCappelletti94 wants to merge 1 commit into
CodSpeedHQ:mainfrom
LucaCappelletti94:upstream/criterion-compat-missing-docs

Conversation

@LucaCappelletti94

Copy link
Copy Markdown

Bench targets that deny missing_docs compile against criterion 0.8 but fail against codspeed-criterion-compat.

Criterion fixed its macro in 0.8.0 (criterion-rs/criterion.rs#26) by putting a doc attribute on the generated function. This PR applies the same attribute to both criterion_group! expansions and makes the instrumented main private, which is what the fork and upstream criterion already emit.

When this is fixed, we may be able to start using this in apache/datafusion-sqlparser-rs#2587

@LucaCappelletti94
LucaCappelletti94 marked this pull request as ready for review September 28, 2026 06:38
@greptile-apps

greptile-apps Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low risk] Adds a benchmark test and fixes macro documentation.

The PR appears safe to merge.

Summary

The PR documents the public functions generated by both Criterion group macros, makes the instrumented entry point private, and adds a missing_docs benchmark to CI. No actionable issue was identified.

Reviews (1) · Last reviewed commit: "fix(criterion_compat): let benches denyi..."

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

Successfully merging this pull request may close these issues.

1 participant