Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F11669600: D2261.id.diff
Mon, Sep 8, 13:28
Unknown Object (File)
Sun, Sep 7, 08:35
Unknown Object (File)
Tue, Aug 26, 07:31
Unknown Object (File)
Mon, Aug 25, 14:29
Unknown Object (File)
Wed, Aug 20, 15:20
Unknown Object (File)
Wed, Aug 20, 12:24
Unknown Object (File)
Wed, Aug 20, 05:00
Unknown Object (File)
Tue, Aug 19, 15:27
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