mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-12-18 11:00:25 +00:00
doc: add documentaion about wrapping long lines to coding guide
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
parent
38b013f96a
commit
5dc60126e4
@ -69,6 +69,33 @@ import (
|
|||||||
* Use log level `ERROR` when something occurs which is fatal to the operation,
|
* Use log level `ERROR` when something occurs which is fatal to the operation,
|
||||||
but not to the service or application.
|
but not to the service or application.
|
||||||
|
|
||||||
|
### Wrap long lines
|
||||||
|
|
||||||
|
At present, we restrict the number of chars in a line to `120` which is the
|
||||||
|
default value for the `lll` linter check we have in CI. If your source code line
|
||||||
|
or comment goes beyond this limit please try to organize it in such a way it
|
||||||
|
is within the line length limit and help on code reading.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```
|
||||||
|
_, err := framework.RunKubectl(cephCSINamespace, "delete", "cm", "ceph-csi-encryption-kms-config", "--namespace", cephCSINamespace, "--ignore-not-found=true")
|
||||||
|
```
|
||||||
|
|
||||||
|
Instead of above long function signature, we can organize it to something like below
|
||||||
|
which is clear and help on easy code reading.
|
||||||
|
|
||||||
|
```
|
||||||
|
_, err := framework.RunKubectl(
|
||||||
|
cephCSINamespace,
|
||||||
|
"delete",
|
||||||
|
"cm",
|
||||||
|
"ceph-csi-encryption-kms-config",
|
||||||
|
"--namespace",
|
||||||
|
cephCSINamespace,
|
||||||
|
"--ignore-not-found=true")
|
||||||
|
```
|
||||||
|
|
||||||
### Mark Down Rules
|
### Mark Down Rules
|
||||||
|
|
||||||
* MD014 - Dollar signs used before commands without showing output
|
* MD014 - Dollar signs used before commands without showing output
|
||||||
|
Loading…
Reference in New Issue
Block a user