knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add entry for flag documentation (#4403) 

* Add entry for flag documentation

fixes #4077

* Update docs/help/contributor/style-guide/documenting-code.md

Co-authored-by: Samia Nneji <snneji@vmware.com>

Co-authored-by: Samia Nneji <snneji@vmware.com>
This commit is contained in:
Matthias Gubler 2021-11-04 14:51:04 +01:00 committed by GitHub
parent cd34b3eb77
commit 634b285393
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/help/contributor/style-guide/documenting-code.md
View File

@ -258,3 +258,16 @@ Apply code formatting only to special-purpose text:
<some-code> <some-code>
``` ```
```` ````
## Documentation of flags
> Always use the short version of flags used in a command rather than the extended version. For example, use `-n` rather than `--namespace`.
=== ":white_check_mark: Correct"
```bash
kubectl apply -f <filename>.yaml -n <namespace>
```
=== ":no_entry: Incorrect"
```bash
kubectl apply --filename <filename>.yaml --namespace <namespace>
```