Skip to content

chore: update mdbook (0.5.3) versions#922

Merged
cdc-as81 merged 2 commits into
mainfrom
cdc-as81-update-mdbook-versions
May 27, 2026
Merged

chore: update mdbook (0.5.3) versions#922
cdc-as81 merged 2 commits into
mainfrom
cdc-as81-update-mdbook-versions

Conversation

@cdc-as81
Copy link
Copy Markdown
Collaborator

Summary

Fix mdBook HTML checker warnings caused by inline code spans containing angle-bracket placeholders or Rust generics, and update the mdBook-related tooling versions in mise.toml.

Changes

  • Updated mdBook tooling:
    • mdbook: 0.4.52 -> 0.5.3
    • mdbook-callouts: 0.2.2 -> 0.3.0
    • mdbook-inline-highlighting: 1.0.0 -> 2.0.0
  • Escaped inline generic examples in:
    • docs/book/src/topics/indexing.md
    • docs/book/src/topics/handling-errors.md
    • docs/book/src/migration_guide.md

@cdc-as81 cdc-as81 linked an issue May 26, 2026 that may be closed by this pull request
@github-actions
Copy link
Copy Markdown

Benchmark Results

Hyperfine

Command Mean [ms] Min [ms] Max [ms] Relative
large_sir::baseline 2.7 ± 0.1 2.6 2.9 1.00
large_sir::baseline_households 2.7 ± 0.1 2.6 3.3 1.00 ± 0.04
large_sir::entities 6.1 ± 0.1 5.9 6.3 2.25 ± 0.05
large_sir::households 5.8 ± 0.1 5.6 6.1 2.18 ± 0.05

Criterion

Regressions (slower)
Group Bench Param Change CI Lower CI Upper
counts multi_property_unindexed_entities 11.860% 9.568% 14.226%
sample_entity sample_entity_multi_property_indexed 100000 10.705% 7.463% 13.929%
large_dataset bench_match_entity 8.919% 8.479% 9.331%
sample_entity sample_entity_single_property_indexed 1000 8.321% 6.293% 10.350%
sampling sampling_single_known_length_entities 6.056% 5.333% 6.770%
examples example-basic-infection 5.146% 4.546% 5.695%
large_dataset bench_query_population_indexed_property_entities 4.226% 3.644% 4.929%
large_dataset bench_query_population_property_entities 3.584% 1.959% 5.360%
sampling count_and_sampling_single_known_length_entities 3.455% 3.014% 3.848%
sample_entity sample_entity_single_property_indexed 100000 3.160% 1.353% 4.995%
large_dataset bench_query_population_derived_property_entities 3.051% 2.058% 3.988%
indexing query_people_multiple_individually_indexed_properties_entities 2.475% 1.450% 3.771%
counts reindex_after_adding_more_entities 1.740% 1.407% 2.029%
counts index_after_adding_entities 1.632% 1.443% 1.830%
Improvements (faster)
Group Bench Param Change CI Lower CI Upper
sampling sampling_single_unindexed_concrete_plus_derived_entities -11.972% -12.283% -11.650%
sampling count_and_sampling_single_unindexed_concrete_plus_derived_entiti -11.344% -11.446% -11.241%
sample_entity sample_entity_multi_property_indexed 10000 -9.679% -13.303% -5.931%
sample_entity sample_entity_single_property_indexed 10000 -4.331% -5.636% -2.878%
indexing query_people_count_single_indexed_property_entities -2.368% -2.733% -1.884%
indexing with_query_results_single_indexed_property_entities -2.211% -2.476% -1.954%
sampling sampling_multiple_l_reservoir_entities -2.119% -2.319% -1.943%
indexing with_query_results_multiple_individually_indexed_properties_enti -1.886% -2.438% -1.192%
Unchanged / inconclusive (CI crosses 0%)
Group Bench Param Change CI Lower CI Upper
sample_entity sample_entity_multi_property_indexed 1000 -3.018% -5.752% -0.033%
sample_entity sample_entity_whole_population 100000 1.918% 0.846% 3.022%
sample_entity sample_entity_whole_population 10000 1.851% -0.532% 4.718%
indexing query_people_indexed_multi-property_entities -1.519% -4.367% 1.038%
examples example-births-deaths 1.437% 0.868% 2.081%
sampling sampling_multiple_unindexed_entities -1.310% -1.848% -0.769%
counts multi_property_indexed_entities 1.201% 0.926% 1.462%
sample_entity sample_entity_single_property_unindexed 10000 0.807% 0.344% 1.265%
sample_entity sample_entity_whole_population 1000 0.782% -0.293% 1.894%
sampling sampling_single_l_reservoir_entities -0.743% -1.226% -0.332%
algorithm_benches algorithm_sampling_single_l_reservoir 0.723% 0.471% 1.056%
large_dataset bench_query_population_multi_unindexed_entities 0.558% 0.087% 1.188%
indexing query_people_count_multiple_individually_indexed_properties_enti 0.499% 0.126% 1.047%
algorithm_benches algorithm_sampling_single_rand_reservoir -0.414% -0.963% 0.039%
large_dataset bench_filter_unindexed_entity -0.413% -4.152% 3.103%
indexing with_query_results_indexed_multi-property_entities -0.411% -1.073% 0.224%
counts single_property_unindexed_entities -0.400% -1.072% 0.137%
sample_entity sample_entity_single_property_unindexed 100000 0.342% 0.072% 0.664%
sample_entity sample_entity_single_property_unindexed 1000 0.327% 0.039% 0.652%
algorithm_benches algorithm_sampling_multiple_l_reservoir 0.309% -0.247% 0.781%
sampling sampling_multiple_known_length_entities -0.248% -0.521% 0.068%
algorithm_benches algorithm_sampling_single_known_length 0.244% -0.351% 0.963%
counts concrete_plus_derived_unindexed_entities -0.196% -0.588% 0.250%
indexing query_people_single_indexed_property_entities -0.138% -0.451% 0.146%
algorithm_benches algorithm_sampling_multiple_known_length 0.136% -0.211% 0.585%
large_dataset bench_query_population_multi_indexed_entities 0.135% -0.113% 0.411%
sampling sampling_single_unindexed_entities 0.101% -0.001% 0.198%
large_dataset bench_filter_indexed_entity 0.060% -8.379% 8.949%
counts single_property_indexed_entities 0.058% -0.197% 0.307%
indexing query_people_count_indexed_multi-property_entities -0.029% -0.460% 0.488%
Not Compared (no baseline yet)
Group Bench Reason
(none)

github-actions Bot added a commit that referenced this pull request May 26, 2026
Copy link
Copy Markdown
Collaborator

@RobertJacobsonCDC RobertJacobsonCDC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The correct fix is to escape the opening < character like we do elsewhere:

...have functions that return `Result\<U, V>` to indicate...

Manually constructing a <code> block is fragile, hard to read, and breaks highlighting of inline code.

@github-actions
Copy link
Copy Markdown

Benchmark Results

Hyperfine

Command Mean [ms] Min [ms] Max [ms] Relative
large_sir::baseline 3.3 ± 0.2 3.2 4.4 1.01 ± 0.06
large_sir::baseline_households 3.3 ± 0.0 3.2 3.4 1.00
large_sir::entities 7.6 ± 0.1 7.5 8.0 2.34 ± 0.04
large_sir::households 7.3 ± 0.1 7.2 7.7 2.25 ± 0.04

Criterion

Regressions (slower)
Group Bench Param Change CI Lower CI Upper
sample_entity sample_entity_multi_property_indexed 10000 24.033% 22.410% 25.763%
sample_entity sample_entity_multi_property_indexed 1000 23.300% 20.954% 25.677%
sample_entity sample_entity_multi_property_indexed 100000 18.302% 16.263% 20.169%
indexing query_people_count_single_indexed_property_entities 13.518% 10.207% 17.848%
sampling sampling_multiple_known_length_entities 4.994% 4.322% 5.749%
large_dataset bench_query_population_multi_unindexed_entities 4.804% 2.424% 7.292%
counts reindex_after_adding_more_entities 1.880% 1.658% 2.105%
large_dataset bench_query_population_multi_indexed_entities 1.824% 1.255% 2.627%
large_dataset bench_match_entity 1.629% 1.130% 2.128%
indexing query_people_multiple_individually_indexed_properties_entities 1.384% 1.020% 1.704%
Improvements (faster)
Group Bench Param Change CI Lower CI Upper
counts multi_property_unindexed_entities -11.567% -14.214% -8.403%
sample_entity sample_entity_single_property_indexed 10000 -7.288% -8.815% -5.805%
sample_entity sample_entity_single_property_indexed 1000 -5.045% -6.086% -3.945%
counts single_property_unindexed_entities -4.206% -5.700% -2.663%
sampling count_and_sampling_single_known_length_entities -4.123% -4.787% -3.478%
sample_entity sample_entity_single_property_indexed 100000 -4.064% -5.357% -2.736%
counts concrete_plus_derived_unindexed_entities -3.505% -5.332% -1.187%
large_dataset bench_query_population_property_entities -2.956% -4.871% -1.491%
sampling sampling_single_l_reservoir_entities -2.754% -3.263% -2.301%
sample_entity sample_entity_whole_population 1000 -2.410% -3.363% -1.465%
examples example-births-deaths -2.224% -3.214% -1.311%
sample_entity sample_entity_whole_population 10000 -1.995% -2.804% -1.222%
Unchanged / inconclusive (CI crosses 0%)
Group Bench Param Change CI Lower CI Upper
large_dataset bench_filter_unindexed_entity 2.970% -0.971% 7.502%
sample_entity sample_entity_whole_population 100000 -1.864% -2.945% -0.785%
large_dataset bench_query_population_derived_property_entities 1.645% 0.972% 2.334%
indexing query_people_count_multiple_individually_indexed_properties_enti 1.439% 0.546% 2.081%
indexing with_query_results_multiple_individually_indexed_properties_enti 1.334% 0.676% 2.061%
indexing with_query_results_single_indexed_property_entities -1.271% -1.843% -0.435%
sampling sampling_multiple_l_reservoir_entities -1.233% -1.992% -0.502%
sampling sampling_multiple_unindexed_entities 1.227% 0.329% 2.135%
large_dataset bench_filter_indexed_entity -1.215% -9.252% 7.854%
sampling count_and_sampling_single_unindexed_concrete_plus_derived_entiti -1.103% -1.209% -0.985%
counts multi_property_indexed_entities 1.096% 0.075% 2.075%
indexing query_people_single_indexed_property_entities 0.814% -0.001% 1.749%
algorithm_benches algorithm_sampling_multiple_known_length -0.775% -1.282% -0.356%
sampling sampling_single_known_length_entities 0.637% -1.519% 3.246%
algorithm_benches algorithm_sampling_single_known_length -0.607% -1.470% 0.053%
indexing with_query_results_indexed_multi-property_entities -0.530% -1.551% 0.268%
indexing query_people_count_indexed_multi-property_entities 0.505% 0.051% 0.998%
counts index_after_adding_entities 0.445% 0.226% 0.678%
examples example-basic-infection -0.307% -0.990% 0.320%
sample_entity sample_entity_single_property_unindexed 10000 -0.144% -0.550% 0.210%
counts single_property_indexed_entities 0.124% -0.248% 0.653%
sample_entity sample_entity_single_property_unindexed 1000 -0.106% -0.537% 0.425%
sample_entity sample_entity_single_property_unindexed 100000 -0.106% -0.469% 0.214%
algorithm_benches algorithm_sampling_multiple_l_reservoir -0.080% -0.569% 0.361%
sampling sampling_single_unindexed_entities 0.076% 0.024% 0.141%
algorithm_benches algorithm_sampling_single_rand_reservoir 0.060% -0.604% 0.811%
sampling sampling_single_unindexed_concrete_plus_derived_entities -0.046% -0.136% 0.028%
algorithm_benches algorithm_sampling_single_l_reservoir 0.041% -0.521% 0.672%
large_dataset bench_query_population_indexed_property_entities 0.010% -0.473% 0.748%
indexing query_people_indexed_multi-property_entities 0.004% -0.273% 0.326%
Not Compared (no baseline yet)
Group Bench Reason
(none)

github-actions Bot added a commit that referenced this pull request May 27, 2026
* `-r`, `--random-seed <RANDOM_SEED>` — Random seed

Default value: `0`
* `-c`, `--config <CONFIG>` — Optional path for a global properties config file
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This <CONFIG> is still eaten by the converter and appears to be the cause of the remaining warning. This file is generated, so it's not a matter of simply escaping the < in this case. I personally don't think it's a big deal, and considering the fact that it's not clear what the fix is in this case, maybe we consider it out of scope for this PR. Just thought I'd point it out.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also don't see a way to exclude cli-usage.md from preprocessing by mdbook-inline-highlighting. 🤷

@cdc-as81 cdc-as81 merged commit 863daa6 into main May 27, 2026
22 checks passed
@cdc-as81 cdc-as81 deleted the cdc-as81-update-mdbook-versions branch May 27, 2026 19:53
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.

Update the MDBook toolchain

3 participants