Render --help=stats from the help model - #387
Merged
Merged
Conversation
…ference) Port the --help=stats topic off the imperative RenderStats onto the shared help model: add StatsSection() (the SOT-tagged --summary/--histogram flags as model entries, plus worked examples as verbatim commands with wrapping prose), route --help=stats through TopicReference, and include it in BuildReference so --man / --markdown / --help=full gain the section. The topic now wraps to --width and indents consistently; delete RenderStats and its RenderHelp branch. Regenerate XFF.md; update help_build_test (section list) and help_render_test (render stats via the model, not RenderHelp).
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
1 participant
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.
First slice of retiring the imperative prose-topic renderers onto the shared help model (help EPIC #154).
What
help_build.cc: addStatsSection()- the--summary/--histogramflags pulled from the globals SOT via thestatstopic tag (as model entries with details), plus worked examples rendered as verbatim commands + wrapping prose (the cookbook pattern, so they read well at narrow--width).--help=statsthroughTopicReference, and addStatsSectiontoBuildReferenceso--man/--markdown/--help=fullgain the section (completeness).RenderStatsand itsRenderHelpbranch.Effect
--help=statsnow wraps to--widthand indents consistently (previously a fixed-width pre-formatted blob). Verified--width=60: prose and example explanations wrap; only the atomic flag synopses exceed (same as every option entry in the reference).Test
bazel test //xff/...(lean 85) and--config=xff_full(90, incl. the XFF.md drift guard) green.RenderTopicDochelper) updated.Next slices: config / cookbook / notice / license (verbatim) / help-guide, one PR each.