docs: fix optional arguments shown as required, document defaults and dry-run - #122
Merged
Merged
Conversation
… dry-run Continues the README audit. These are presentation bugs rather than wrong statements, but each one makes a reader pass an argument they do not need or miss that a command is safe to try. Three usage lines showed optional arguments in <angle brackets> as if they were required: hostname-suffix in reset-organization-workspace-passwords and set-organization-storage-backend, and hostname-suffix, reason and estimatedEndTime in set-organization-maintenance-mode. The defaults behind them were undocumented too, so both BYODB commands now list their arguments and options the way the rest of the README does. Five sections did not mention dry-run even though the command prints DRY RUN without --force: the two BYODB ones above plus projects-add-feature, projects-remove-feature and organizations-add-feature. The neighbouring add-feature-to-templates section already carried that sentence, so the same wording is reused. Also documents the connectionUrl default for storage:lineage-events-export and fixes "Hostname sUffix". Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
martinsifra
approved these changes
Sep 8, 2026
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
2 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.
Changes:
Second half of the README audit - the presentational findings. Nothing here is a false statement; each one just makes a reader do more work than needed.
<angle brackets>:hostname-suffixinmanage:reset-organization-workspace-passwordsandmanage:set-organization-storage-backend, andhostname-suffix,reason,estimatedEndTimeinmanage:set-organization-maintenance-mode. Now[<bracketed>].hostname-suffix=keboola.comfor both BYODB commands, andconnectionUrl=https://connection.keboola.comforstorage:lineage-events-export. Both BYODB sections now list arguments and options in the same format the rest of the README uses.DRY RUNwithout--force: the two BYODB commands above, plusmanage:projects-add-feature,manage:projects-remove-featureandmanage:organizations-add-feature. Verified in each command before documenting it. Reuses the exact sentence the neighbouringadd-feature-to-templatessection already had, rather than inventing new phrasing.Hostname sUffix.Rebased onto
mainnow that #120 is merged, so this is a single commit againstmain. Supersedes #121, which GitHub auto-closed when #120 was merged with branch deletion — its base branch disappeared and a closed PR cannot be retargeted.After both, re-running the audit script reports 0 problems: every registered command has its own section, every default is documented, no optional argument is presented as required, and every command with
--forcesays so.Docs only, no code touched.
Additional notes
🤖 Generated with Claude Code