Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Jun 22, 22:46
Unknown Object (File)
Sun, Jun 22, 16:08
Unknown Object (File)
Sun, Jun 22, 07:52
Unknown Object (File)
Sun, Jun 22, 07:42
Unknown Object (File)
Sat, Jun 21, 14:42
Unknown Object (File)
Fri, Jun 20, 18:54
Unknown Object (File)
Fri, Jun 20, 18:51
Unknown Object (File)
Fri, Jun 20, 14:33
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