Page MenuHomeDevCentral

Reformat documentation blocks
ClosedPublic

Authored by dereckson on Feb 26 2020, 02:15.
Tags
None
Referenced Files
F21135002: D2261.id5680.diff
Sat, Jan 17, 10:43
F21134770: D2261.diff
Sat, Jan 17, 10:14
Unknown Object (File)
Fri, Jan 16, 15:22
Unknown Object (File)
Fri, Jan 16, 12:31
Unknown Object (File)
Mon, Jan 12, 16:44
Unknown Object (File)
Mon, Jan 12, 12:40
Unknown Object (File)
Thu, Jan 8, 19:43
Unknown Object (File)
Wed, Jan 7, 15:09
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