Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F11076985: D2261.id.diff
Wed, Aug 13, 05:22
Unknown Object (File)
Mon, Aug 11, 07:54
Unknown Object (File)
Mon, Aug 11, 04:12
Unknown Object (File)
Mon, Aug 11, 02:15
Unknown Object (File)
Mon, Aug 11, 02:15
Unknown Object (File)
Sun, Aug 10, 22:05
Unknown Object (File)
Thu, Aug 7, 16:10
Unknown Object (File)
Tue, Aug 5, 23:01
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