Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F10742290: D2261.id5681.diff
Fri, Jul 25, 15:34
Unknown Object (File)
Mon, Jul 21, 15:57
Unknown Object (File)
Wed, Jul 16, 10:57
Unknown Object (File)
Tue, Jul 15, 17:08
Unknown Object (File)
Tue, Jul 15, 14:55
Unknown Object (File)
Thu, Jul 10, 17:56
Unknown Object (File)
Thu, Jul 10, 14:39
Unknown Object (File)
Wed, Jul 9, 06:52
Subscribers
None

Details

Summary

This change normalizes the documentation blocks both among Salt
and deployed scripts.

Context

At some point, style of all the blocks have changed from this style:

#   -------------------------------------------------------------
#   Container
#   -------------------------------------------------------------

to this one:

#   -------------------------------------------------------------
#   Container
#   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Reformat utility

The reformat script is intended to be used as reformat <file>.
That would a good linter/autofixer.

To convert all the repository, the following commands have been used:
git ls-files | xargs -n 1 utils/reformat.py

Test Plan

Proofread blocks, convert all this repo

Diff Detail

Repository
rOPS Nasqueron Operations
Lint
Lint Skipped
Unit
No Test Coverage
Branch
reformat
Build Status
Buildable 3499
Build 3748: arc lint + arc unit