Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F27851230: D2261.id5681.diff
Fri, May 8, 15:41
F27803982: D2261.id5680.diff
Fri, May 8, 08:08
F27799055: D2261.id.diff
Fri, May 8, 07:26
Unknown Object (File)
Thu, May 7, 14:39
Unknown Object (File)
Tue, May 5, 03:23
Unknown Object (File)
Wed, Apr 29, 00:13
Unknown Object (File)
Tue, Apr 28, 16:33
Unknown Object (File)
Thu, Apr 23, 10:03
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