Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F12577982: D2261.diff
Tue, Nov 11, 08:45
F12570384: D2261.id5679.diff
Tue, Nov 11, 03:36
F12570360: D2261.id5681.diff
Tue, Nov 11, 03:35
F12558692: D2261.diff
Mon, Nov 10, 19:17
F12555498: D2261.diff
Mon, Nov 10, 17:00
Unknown Object (File)
Mon, Nov 10, 04:31
Unknown Object (File)
Wed, Nov 5, 16:55
Unknown Object (File)
Wed, Nov 5, 12: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 Not Applicable
Unit
Tests Not Applicable