Repository navigation
docs: fix typos in flag docs and examples - #5
Open
Avicennasis wants to merge 1 commit into
Open
Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
Fix misspellings and grammar in the string_flag_with_values docstring (and the Stardoc-generated docs/variant/defs.md, kept byte-identical so the diff test passes) and in the example READMEs. The kitchen example's printed garlic label is corrected in basil_fresh.cc and in the README output that quotes it. Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
Avicennasis
requested review from
agondek-at-asml,
astachec-at-asml and
emilwaijers
as code owners
October 23, 2026 06:00
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
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
Fix typos and grammar across 7 files:
variant/private/flags.bzl+docs/variant/defs.md(string_flag_with_valuesdocstring): "True if by all supported values" → "True if all supported values"; "visiblility" → "visibility".defs.mdis Stardoc output, so the fix is made in the.bzlsource and mirrored byte-identically into the generated file, which keepsstardoc_with_diff_testgreen.examples/README.md: "augumenting" → "augmenting"examples/implicit_settings/README.md: "augument" → "augment"examples/tv_channels/README.md: "to configure and TV, radio channels" → "to configure TV and radio channels"examples/kitchen/basil_fresh.cc+examples/kitchen/README.md: "Noticable" → "Noticeable". This is a string the example program prints, so the source and the two README output blocks that quote it change together.No functional changes to the rules: comments and documentation only, plus that one printed label in the kitchen example.