docs: use language-neutral type names in generated filter docs#751
Open
leseb wants to merge 3 commits into
Open
docs: use language-neutral type names in generated filter docs#751leseb wants to merge 3 commits into
leseb wants to merge 3 commits into
Conversation
Replace Rust-specific type names (usize, u32, u64, f32, f64, etc.) with language-neutral alternatives (integer, number) in the filter docs generator so user-facing configuration tables are not tied to implementation details. Signed-off-by: Sébastien Han <seb@redhat.com>
leseb
requested review from
franciscojavierarceo,
shaneutt and
twghu
as code owners
7 tasks
praxis-bot
reviewed
Jul 1, 2026
praxis-bot
left a comment
praxis-bot
left a comment
Collaborator
There was a problem hiding this comment.
PR Review
Replaces Rust-specific numeric type names (usize, u32, u64, f64, etc.) with language-neutral names (integer, number) in generated filter docs.
Overall Assessment
The code change in render_type_path is correct and straightforward. The 23 regenerated doc files are mechanical output of that change. Two test coverage gaps should be addressed.
Findings
| Severity | File | Description |
|---|---|---|
| Large | xtask/src/filter_docs.rs |
No unit tests for the new integer/number type mapping |
| Medium | xtask/src/filter_docs.rs |
sample_filter_entry() fixture uses stale "u64" type_str |
Add numeric_types_render_language_neutral test covering integer and number type mappings. Update sample_filter_entry fixture and dependent assertions to use the language-neutral type name. Signed-off-by: Sébastien Han <seb@redhat.com>
…-integer Signed-off-by: Sébastien Han <seb@redhat.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
xtask/src/filter_docs.rs) to map Rust-specific numeric types (usize,u32,u64,i64, etc.) tointegerand floating-point types (f32,f64) tonumberin generated configuration tablesTest plan
make lintpasses (clippy, fmt, lint-deps, lint-example-tests, lint-ai-isolation, sync-example-readme, lint-filter-docs)cargo xtask generate-filter-docsregenerates docs cleanlycargo xtask lint-filter-docsconfirms generated docs are up to datedocs/filters/README.mdRust code snippet (Option<usize>) is untouched