Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
Unknown Object (File)
Thu, May 16, 08:18
Unknown Object (File)
Thu, May 16, 07:58
Unknown Object (File)
Wed, May 15, 00:09
Unknown Object (File)
Tue, May 14, 01:14
Unknown Object (File)
Mon, May 13, 19:27
Unknown Object (File)
Thu, May 9, 19:20
Unknown Object (File)
Thu, May 9, 15:07
Unknown Object (File)
Thu, May 9, 12:32
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 Skipped
Unit
No Test Coverage
Branch
reformat
Build Status
Buildable 3498
Build 3747: arc lint + arc unit