From 7b3f9f9dab2fa954ff436ece98f1db6cc28e5222 Mon Sep 17 00:00:00 2001 From: neilotoole Date: Sun, 7 May 2023 00:29:42 -0600 Subject: [PATCH] Doc cleanup --- CHANGELOG.md | 12 ++++++++---- cli/cmd_config_edit.go | 5 +++-- cli/cmd_config_get.go | 4 ++-- cli/cmd_config_ls.go | 2 +- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e45503e..23bbf389 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,14 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Breaking changes are annotated with ☢️. -## Upcoming +## [v0.34.0] - 2023-05-07 -This release significantly overhauls `sq`'s config mechanism ([#199]). There -are several minor breaking changes ☢️. +This release significantly overhauls `sq`'s config mechanism ([#199]). +For an overview, see the new [config docs](https://sq.io/docs/config). + +Alas, this release has several minor breaking changes ☢️. ### Added -- `sq config get` prints config. DOCS +- `sq config ls` shows config. +- `sq config get` gets individual config option. - `sq config set` sets config values. - `sq config edit` edits config. - Editor can be specified via `$EDITOR` or `$SQ_EDITOR`. @@ -452,3 +455,4 @@ make working with lots of sources much easier. [v0.31.0]: https://github.com/neilotoole/sq/compare/v0.30.0...v0.31.0 [v0.32.0]: https://github.com/neilotoole/sq/compare/v0.31.0...v0.32.0 [v0.33.0]: https://github.com/neilotoole/sq/compare/v0.32.0...v0.33.0 +[v0.34.0]: https://github.com/neilotoole/sq/compare/v0.33.0...v0.34.0 diff --git a/cli/cmd_config_edit.go b/cli/cmd_config_edit.go index ca9f31b3..42c2774b 100644 --- a/cli/cmd_config_edit.go +++ b/cli/cmd_config_edit.go @@ -35,8 +35,9 @@ func newConfigEditCmd() *cobra.Command { return execConfigEditSource(cmd, args) }, - Short: "Edit config or source options", - Long: `Edit config or source options in the editor specified in envar $SQ_EDITOR or $EDITOR.`, + Short: "Edit config in $EDITOR", + Long: `Edit config or source options in the editor specified +in envar $SQ_EDITOR or $EDITOR.`, Example: ` # Edit default options $ sq config edit diff --git a/cli/cmd_config_get.go b/cli/cmd_config_get.go index 536d74f1..96edb872 100644 --- a/cli/cmd_config_get.go +++ b/cli/cmd_config_get.go @@ -10,8 +10,8 @@ import ( func newConfigGetCmd() *cobra.Command { cmd := &cobra.Command{ Use: "get", - Short: "Show config", - Long: `Show config. By default, only explicitly set options are shown. + Short: "Show config option", + Long: `Show config option. By default, only explicitly set options are shown. Use the -v flag to see all options. When flag --src is provided, show config just for that source.`, Args: cobra.ExactArgs(1), diff --git a/cli/cmd_config_ls.go b/cli/cmd_config_ls.go index 8c73a665..a1b702d6 100644 --- a/cli/cmd_config_ls.go +++ b/cli/cmd_config_ls.go @@ -10,7 +10,7 @@ import ( func newConfigListCmd() *cobra.Command { cmd := &cobra.Command{ Use: "ls [--src @HANDLE]", - Short: "Show config", + Short: "List config options", Long: `Show config. By default, only explicitly set options are shown. Use the -v flag to see all options. When flag --src is provided, show config just for that source.`,