Update README to match command implementations#26
Merged
Conversation
- Document the --with-clickhouse flag for CheckDBDevelopment, CheckDBRollback and RunSpecs (the DB commands previously said "does not accept flags") - Fix RunSpecs split-resultset target filename (resultset.N.json, no leading dot) so it matches CheckCoverage's coverage/resultset.*.json glob - Add --with-database to the CheckSidekiqSchedulerConfig flag summary and correct its description - Normalize flag names to hyphenated form and fix the broken railtie Gemfile snippet and assorted typos
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.
Summary
Bring
README.mdback in line with the actual command implementations. The docs had drifted: the ClickHouse options added recently were undocumented, and a couple of details no longer matched the code.Changes
--with-clickhousedocumented forCheckDBDevelopment,CheckDBRollbackandRunSpecs. The two DB commands previously claimed they "do not accept flags", but both now accept this flag (ch:create/ch:migrate/ch:rollback_new_migrations).RunSpecssplit-resultset filename corrected — the renamed file isresultset.#{node_index}.json(no leading dot), not.resultset.#{node_index}.json. This now matches thecoverage/resultset.*.jsonglob thatCheckCoveragealready documents (the two had contradicted each other).CheckSidekiqSchedulerConfig— added--with-databaseto its flag summary and fixed its description (it was copy-pasted as "before executing specs").gem installcommand fixed — used the underscore nameci_helper, but the gem is published asci-helper; RubyGems treats those as different names, so the command would fail.--extra-paths,--ignored-paths, plus the missing--on threeRunSpecsflags), fixed the broken railtie Gemfile snippet (missing closing quote), and correctedcoma→commaandCoolCoomand→CoolCommand.Documentation only — no code changes.