Skip to content

Commit

Permalink
Doc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
neilotoole committed May 7, 2023
1 parent 11525ea commit 7b3f9f9
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 9 deletions.
12 changes: 8 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -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
5 changes: 3 additions & 2 deletions cli/cmd_config_edit.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions cli/cmd_config_get.go
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
2 changes: 1 addition & 1 deletion cli/cmd_config_ls.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.`,
Expand Down

0 comments on commit 7b3f9f9

Please sign in to comment.