Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F24765411: D2261.diff
Mon, Mar 9, 19:16
F24765392: D2261.id5680.diff
Mon, Mar 9, 19:16
F24765373: D2261.id5679.diff
Mon, Mar 9, 19:16
F24762470: D2261.diff
Mon, Mar 9, 15:51
Unknown Object (File)
Sat, Mar 7, 14:44
Unknown Object (File)
Tue, Mar 3, 01:27
Unknown Object (File)
Tue, Mar 3, 01:27
Unknown Object (File)
Mon, Mar 2, 13: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 Not Applicable
Unit
Tests Not Applicable