Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F34207478: D2261.diff
Fri, Jun 26, 15:54
F34177917: D2261.id5679.diff
Fri, Jun 26, 01:56
Unknown Object (File)
Tue, Jun 23, 09:26
Unknown Object (File)
Mon, Jun 22, 22:20
Unknown Object (File)
Mon, Jun 22, 07:40
Unknown Object (File)
Sat, Jun 20, 16:00
Unknown Object (File)
Thu, Jun 18, 08:15
Unknown Object (File)
Thu, Jun 18, 08:10
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