Repository navigation
Normalize English prose formatting across maintained files - #195
Merged
Merged
Conversation
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.
Changed
English explanatory prose was edited for readability and consistent punctuation in
README.md, nine maintained documents underdoc/, and the explanatory comments ofGemfile,Rakefile,automatic.gemspec,script/build,.github/workflows/ci.yml,lib/,plugins/andspec/.doc/DEPLOYMENT.md,doc/PLUGINS.md,doc/AI_TUTORIAL.md,doc/RELEASING.md,doc/QUICKSTART.md,doc/POLICY.md, theGemfilecomment and theci.ymlcomments.and,but,so,because) where the logical relation called for one. Examples: "The supported checkout setups are shown below. Start with the minimal setup." and the clauses inplugins/filter/join.rbandspec/lib/automatic/pipeline_spec.rb.doc/REQUIREMENTS.mdMarkdown-properties list, thedoc/RELEASING.mdprerequisite, metadata-source, package-content and gem-metadata lists, and thedoc/PLUGINS.mdcredential list now use capitalized items that end with a period, in place of a single sentence chained with semicolons. Thedoc/BASIC_DESIGN.md"either ... or" list was reworded the same way, keeping both alternatives.Preserved behavior
Name,Author,Created,Updated,Copyright,License,Description), shebangs and magic comments are untouched.must,shall,should,may,never,always) and rule strength are unchanged. No rule, item or sentence was removed.doc/DEPLOYMENT.mdline 32 anddoc/RELEASING.mdline 383), headerDescription::andAuthor:fields, and table rows were not rewrapped. Terse table-cell fragments such as "Required; must be greater than zero." were left as written.Version History
VERSION,lib/automatic/version.rb,doc/VERSIONSand theautomatic.gemspecversion value are unchanged. This change touches documentation and comments only, so it adds no release-history entry and does not changeUpdated.Validation
doc/DEPLOYMENT.md:32(87) and table rowsgit diff --checkbundle exec rake spec(default suite, no optional groups, no network)bundle exec bin/automatic --versionand--help, with--helpcompared to the base checkout26.09(0). Help output byte-identical to base (0)ruby -con the 52 changed Ruby-syntax files, plus a Ripper token-stream comparison with comments and whitespace excluded. Alsobash -n script/buildand a YAML parse ofci.yml.bash -n(0). YAML load (0)git logandgit difffromorigin/masterto HEAD.Smoke test
The CLI was run from the checkout through
bundle execon Ruby 3.3.6.--versionprinted26.09. The--helpoutput was compared with the output from anorigin/masterworktree and was identical. No network spec or integration Recipe was run.Exit status
git diff --check: 0.bundle exec rake spec: 0.automatic --version: 0.automatic --help: 0.ruby -c(all files): 0. Token comparison: 0.Diff
64 files changed, 402 insertions, 374 deletions. The changes are confined to prose in
README.md,doc/*.md(9 files) and comments in 54 non-Markdown files.Branch and Commit
masterat793bc96ff00a9e8dcf9eb60a39f81a5f2b550970docs/normalize-english-prose(newly created fromorigin/master)ac77db99e023d418f7c374422c77efe409510d3f"Normalize English prose formatting across maintained files"Pull Request Verification
Read back after creation: base
master(793bc96), headdocs/normalize-english-prose(ac77db9), title as specified, state open and not merged, mergeable state clean, 1 commit, 64 changed files (+402/-374). The body contains these nine sections in the specified order and no session URL or credential.