Skip to content

Commit

Permalink
fix: Doc regression ⚓
Browse files Browse the repository at this point in the history
  • Loading branch information
gabyx committed Jan 23, 2024
1 parent 38f9be3 commit b7795be
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .githooks/pre-commit/cli-docs-up-to-date
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ for file in $STAGED_FILES; do
exit 1
}

git add "$repoDir/docs/cli/"*
# git add "$repoDir/docs/cli/"*

echo "* Docs regenerated." >&2
else
Expand Down
17 changes: 8 additions & 9 deletions docs/dialog/dialog.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@ dialog

### SEE ALSO

- [dialog entry](dialog_entry.md) - Shows a entry dialog.
- [dialog file-save](dialog_file-save.md) - Shows a file save dialog.
- [dialog file-selection](dialog_file-selection.md) - Shows a file selection
dialog.
- [dialog message](dialog_message.md) - Shows a message dialog.
- [dialog notify](dialog_notify.md) - Shows a notification.
- [dialog options](dialog_options.md) - Shows a options selection dialog.

###### Auto generated by spf13/cobra
* [dialog entry](dialog_entry.md) - Shows a entry dialog.
* [dialog file-save](dialog_file-save.md) - Shows a file save dialog.
* [dialog file-selection](dialog_file-selection.md) - Shows a file selection dialog.
* [dialog message](dialog_message.md) - Shows a message dialog.
* [dialog notify](dialog_notify.md) - Shows a notification.
* [dialog options](dialog_options.md) - Shows a options selection dialog.

###### Auto generated by spf13/cobra
14 changes: 7 additions & 7 deletions docs/dialog/dialog_entry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ Shows a entry dialog.

### Synopsis

Shows a entry dialog similar to `zenity`. Currently extra buttons are not
supported on all platforms. Unix/Windows supports multiple extra buttons, MacOS
does not.
Shows a entry dialog similar to `zenity`.
Currently extra buttons are not supported on all platforms.
Unix/Windows supports multiple extra buttons, MacOS does not.

# Exit Codes:

- `0` : User pressed `Ok`.
- `1` : User pressed `Cancel` or closed the dialog.
- `2` : The user pressed an extra button. The output contains the index of that
button.
- `2` : The user pressed an extra button.
The output contains the index of that button.

```
dialog entry
Expand Down Expand Up @@ -54,6 +54,6 @@ dialog entry

### SEE ALSO

- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
* [dialog](dialog.md) - Githooks dialog application similar to `zenity`.

###### Auto generated by spf13/cobra
###### Auto generated by spf13/cobra
10 changes: 5 additions & 5 deletions docs/dialog/dialog_file-save.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Shows a file save dialog.
### Synopsis

Shows a file save dialog similar to `zenity`.

# Exit Codes:

- `0` : User pressed `Ok`. The output contains the selected paths separated by
`--separator`. All paths use forward slashes on any platform.
- `0` : User pressed `Ok`. The output contains the selected paths
separated by `--separator`. All paths use forward slashes
on any platform.
- `1` : User pressed `Cancel` or closed the dialog.
- `5` : The dialog was closed due to timeout.

Expand Down Expand Up @@ -48,6 +48,6 @@ dialog file-save

### SEE ALSO

- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
* [dialog](dialog.md) - Githooks dialog application similar to `zenity`.

###### Auto generated by spf13/cobra
###### Auto generated by spf13/cobra
9 changes: 5 additions & 4 deletions docs/dialog/dialog_file-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ Shows a file selection dialog similar to `zenity`.

# Exit Codes:

- `0` : User pressed `Ok`. The output contains the selected paths separated by
`--separator`. All paths use forward slashes on any platform.
- `0` : User pressed `Ok`. The output contains the selected paths
separated by `--separator`. All paths use forward slashes
on any platform.
- `1` : User pressed `Cancel` or closed the dialog.
- `5` : The dialog was closed due to timeout.

Expand Down Expand Up @@ -47,6 +48,6 @@ dialog file-selection

### SEE ALSO

- [dialog](dialog.md) - Githooks dialog application similar to `zenity`.
* [dialog](dialog.md) - Githooks dialog application similar to `zenity`.

###### Auto generated by spf13/cobra
###### Auto generated by spf13/cobra

0 comments on commit b7795be

Please sign in to comment.