Skip to content

Commit

Permalink
Merge pull request juju#17745 from gfouillet/docfix/short_flag_with_t…
Browse files Browse the repository at this point in the history
…wo_dashes

juju#17745

- Before this commit, documentation generation was broken due to a bug on juju/cmd: short flag were suffixed by two dashes in documentation, instead of one (ex: `--B, -no-browser-login`)
- After this commit, documentation generation is fixed regarding that issue (ex: `-B, -no-browser-login`)

See also: https://github.com/juju/cmd/releases/tag/v3.0.15

<!-- 
The PR title should match: <type>(optional <scope>): <description>.

Please also ensure all commits in this PR comply with our conventional commits specification:
https://docs.google.com/document/d/1SYUo9G7qZ_jdoVXpUVamS5VCgHmtZ0QA-wZxKoMS-C0 
-->

<!-- Why this change is needed and what it does. -->

## Checklist

<!-- If an item is not applicable, use `~strikethrough~`. -->

- ~[ ] Code style: imports ordered, good names, simple structure, etc~
- ~[ ] Comments saying why design decisions were made~
- ~[ ] Go unit tests, with comments saying what you're testing~
- ~[ ] [Integration tests](https://github.com/juju/juju/tree/main/tests), with comments saying what you're testing~
- ~[ ] [doc.go](https://discourse.charmhub.io/t/readme-in-packages/451) added or updated in changed packages~

## QA steps

```sh
juju documentation --split --out=./docs
```
Check that the mono-character flags in generated markdown are prefixed by only one dash.

## Documentation changes

<!-- How it affects user workflow (CLI or API). -->

Will allows to regenerate the doc correctly.

## Links

<!-- Link to all relevant specification, documentation, bug, issue or JIRA card. -->

**Jira card:** [JUJU-6296](https://warthogs.atlassian.net/browse/JUJU-6319), JUJU-6296](https://warthogs.atlassian.net/browse/JUJU-6319)



[JUJU-6296]: https://warthogs.atlassian.net/browse/JUJU-6296?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
jujubot authored Jul 16, 2024
2 parents b080ce3 + 8327d57 commit 0b318e9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ require (
github.com/juju/blobstore/v3 v3.0.2
github.com/juju/charm/v12 v12.0.2
github.com/juju/clock v1.1.1
github.com/juju/cmd/v3 v3.0.14
github.com/juju/cmd/v3 v3.0.15
github.com/juju/collections v1.0.4
github.com/juju/description/v5 v5.0.4
github.com/juju/errors v1.0.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -479,8 +479,8 @@ github.com/juju/clock v1.1.1 h1:NvgHG9DQmOpBevgt6gzkyimdWBooLXDy1cQn89qJzBI=
github.com/juju/clock v1.1.1/go.mod h1:HIBvJ8kiV/n7UHwKuCkdYL4l/MDECztHR2sAvWDxxf0=
github.com/juju/cmd v0.0.0-20171107070456-e74f39857ca0/go.mod h1:yWJQHl73rdSX4DHVKGqkAip+huBslxRwS8m9CrOLq18=
github.com/juju/cmd/v3 v3.0.0-20220202061353-b1cc80b193b0/go.mod h1:EoGJiEG+vbMwO9l+Es0SDTlaQPjH6nLcnnc4NfZB3cY=
github.com/juju/cmd/v3 v3.0.14 h1:KuuamArSH7vQ6SdQKEHYK2scEMkJTEZKLs8abrlW3XE=
github.com/juju/cmd/v3 v3.0.14/go.mod h1:lGtDvm2BG+FKnIS8yY/vrhxQNX9imnL6bPIYGSTchuI=
github.com/juju/cmd/v3 v3.0.15 h1:/n/n/L4CX5hL9Bwkt9QV31Qsa3Vo8GB95gtpQPEIEb0=
github.com/juju/cmd/v3 v3.0.15/go.mod h1:lGtDvm2BG+FKnIS8yY/vrhxQNX9imnL6bPIYGSTchuI=
github.com/juju/collections v0.0.0-20200605021417-0d0ec82b7271/go.mod h1:5XgO71dV1JClcOJE+4dzdn4HrI5LiyKd7PlVG6eZYhY=
github.com/juju/collections v0.0.0-20220203020748-febd7cad8a7a/go.mod h1:JWeZdyttIEbkR51z2S13+J+aCuHVe0F6meRy+P0YGDo=
github.com/juju/collections v1.0.0/go.mod h1:JWeZdyttIEbkR51z2S13+J+aCuHVe0F6meRy+P0YGDo=
Expand Down

0 comments on commit 0b318e9

Please sign in to comment.