fix(doc): double-reexport can lead to empty module#11665
Conversation
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Brillig Execution Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: b328bb5 | Previous: 7ae460f | Ratio |
|---|---|---|---|
rollup-tx-merge |
0.002 s |
0.001 s |
2 |
This comment was automatically generated by workflow using github-action-benchmark.
CC: @TomAFrench
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Execution Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: 281f266 | Previous: 7ae460f | Ratio |
|---|---|---|---|
rollup-checkpoint-merge |
0.003 s |
0.002 s |
1.50 |
This comment was automatically generated by workflow using github-action-benchmark.
CC: @TomAFrench
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark 'Test Suite Duration'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.
| Benchmark suite | Current: b328bb5 | Previous: 7ae460f | Ratio |
|---|---|---|---|
test_report_zkpassport_noir_rsa_ |
2 s |
1 s |
2 |
This comment was automatically generated by workflow using github-action-benchmark.
CC: @TomAFrench
Description
Problem
Resolves an issue mentioned in AztecProtocol/aztec-packages#20747
Summary
The bug happened in code like this:
The way the doc generator works is by checking re-exports, first in submodules:
pub use empty::Emptyintwois found. That causes the moduletwoto be changed in a way thatpub struct Emptyis put insidetwo. That waytwoends up havingEmptyas a direct children.pub use one::twois found. Here we do the same, by placingtwodirectly underone.The problem was that the
twothat was found was the one before point 1, where it didn't haveEmptydirectly inside it. This happened because of the way we link things (we store them in a map, and when something referenced in that map changed, we didn't update the map accordingly).Additional Context
Debugderives because otherwise it was kind of hard to debug thisUser Documentation
Check one:
PR Checklist
cargo fmton default settings.