Refactor commands descriptions #1585
Conversation
Signed-off-by: Pavol Loffay <[email protected]>
pavolloffay
requested review from
black-adder,
jpkrohling,
objectiser,
tiffon,
vprithvi and
yurishkuro
as code owners
| Run: func(cmd *cobra.Command, args []string) { | ||
| fmt.Fprintln(cmd.OutOrStdout(), ` |
There was a problem hiding this comment.
I wanted to make this available in generated docs. Now it is printed when env command is run but also included in generated docs.
There was a problem hiding this comment.
do you have an example of the output you could paste?
There was a problem hiding this comment.
The output is the same as before, Just removed spaces at the beginning.
| @@ -47,9 +47,9 @@ func main() { | |||
|
|
|||
| v := viper.New() | |||
| command := &cobra.Command{ | |||
| Use: "(experimental) jaeger-ingester", | |||
There was a problem hiding this comment.
The use should not include spaces otherwise generated files look like:
(experimental).md
(experimental)_docs.md
(experimental)_env.md
(experimental)_version.md
Codecov Report
@@ Coverage Diff @@
## master #1585 +/- ##
=========================================
- Coverage 98.8% 98.8% -0.01%
=========================================
Files 191 191
Lines 9102 9095 -7
=========================================
- Hits 8993 8986 -7
Misses 85 85
Partials 24 24
Continue to review full report at Codecov.
|
| @@ -89,7 +89,7 @@ func main() { | |||
| Use: "jaeger-all-in-one", | |||
| Short: "Jaeger all-in-one distribution with agent, collector and query in one process.", | |||
| Long: `Jaeger all-in-one distribution with agent, collector and query. Use with caution this version | |||
There was a problem hiding this comment.
"caution as this"
Does it need to be broken into 2 lines?
There was a problem hiding this comment.
just a preference to break lines longer than 100 chars.
| Run: func(cmd *cobra.Command, args []string) { | ||
| fmt.Fprintln(cmd.OutOrStdout(), ` |
There was a problem hiding this comment.
do you have an example of the output you could paste?
|
@objectiser the current output: |
Signed-off-by: Pavol Loffay [email protected]