lab icon indicating copy to clipboard operation
lab copied to clipboard

Linting Errors due to different syntax in template vs. `check-guides.py` script

Open chhei opened this issue 4 years ago • 0 comments

The pre-commit script throws a lot of

ERROR : error-structure-tested : no `Tested on Uberspace` part

because in most guides, people have used the boilerplate template in STYLE.md which says Tested with Loremipsum 1.22.1, Uberspace 7.1.1 while the check-guides.py script requires

    Check(
        "error-structure-tested",
        action="search",
        argument="Tested on Uberspace",
        help="no `Tested on Uberspace` part",
    ),

So contributors used Tested with Loremipsum..., Uberspace, while the script checks for Tested on Uberspace.

I propose to replace this part of the template with a reST list-table structure to make this less error-prone and more standarised.

EDIT: adopted for Issue 1084

.. list-table::
   :widths: 50 25
   :header-rows: 1

   * - Software/Platform
     - Version #
   * - UberSpace
     - 7.yy.z
   * - Loremipsum
     - x.yy.z
   * - Loremfipsum
     - x.yy.z
   * - Loremdipsum
      - x.yy.z

chhei avatar Aug 09 '21 21:08 chhei