Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Feb 5, 15:38
Unknown Object (File)
Wed, Feb 4, 22:38
Unknown Object (File)
Mon, Feb 2, 07:29
Unknown Object (File)
Wed, Jan 28, 11:07
Unknown Object (File)
Tue, Jan 27, 07:52
Unknown Object (File)
Sat, Jan 24, 22:11
Unknown Object (File)
Sat, Jan 17, 10:43
Unknown Object (File)
Sat, Jan 17, 10:14
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