github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-08 11:38:15 +00:00
Code Issues Projects Releases Wiki Activity

Use our own normalizers in the conventions doc

Browse Source
This commit is contained in:
Fabiano Franz 2016-10-10 19:07:07 -03:00
parent 3f7579cacb
commit 0fd5c8d797
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/devel/kubectl-conventions.md
View File

@ -301,17 +301,13 @@ Sample command skeleton:
// MineRecommendedName is the recommended command name for kubectl mine. // MineRecommendedName is the recommended command name for kubectl mine.
const MineRecommendedName = "mine" const MineRecommendedName = "mine"
// MineConfig contains all the options for running the mine cli command. // Long command description and examples.
type MineConfig struct {
mineLatest bool
}
var ( var (
mineLong = dedent.Dedent(` mineLong = templates.LongDesc(`
mine which is described here mine which is described here
with lots of details.`) with lots of details.`)
mineExample = dedent.Dedent(` mineExample = templates.Examples(`
# Run my command's first action # Run my command's first action
kubectl mine first_action kubectl mine first_action
@ -319,6 +315,11 @@ var (
kubectl mine second_action --flag`) kubectl mine second_action --flag`)
) )
// MineConfig contains all the options for running the mine cli command.
type MineConfig struct {
mineLatest bool
}
// NewCmdMine implements the kubectl mine command. // NewCmdMine implements the kubectl mine command.
func NewCmdMine(parent, name string, f *cmdutil.Factory, out io.Writer) *cobra.Command { func NewCmdMine(parent, name string, f *cmdutil.Factory, out io.Writer) *cobra.Command {
opts := &MineConfig{} opts := &MineConfig{}