Changes between Version 1 and Version 2 of patchbot/plugins


Ignore:
Timestamp:
Apr 18, 2022, 2:53:40 AM (5 months ago)
Author:
Matthias Köppe
Comment:

cross-reference to relint

Legend:

Unmodified
Added
Removed
Modified
  • patchbot/plugins

    v1 v2  
    66╘═╧══════╛
    77}}}
    8 = explanations on the patchbot plugins =
     8= patchbot plugins equivalent to `tox -e relint` =
    99
    10 == commit_messages ==
    11 
    12 Check for the existence of a commit message for every commit.
    13 
    14 == coverage ==
    15 
    16 Try to check that coverage did increase.
    17 
    18 The coverage is the percent of functions that are doctested. This must be 100%.
    19 
    20 == non_ascii ==
    21 
    22 Look for the presence of non-ascii characters in python and cython files.
    23 
    24 This detects the presence of the encoding line at the top of files. (TO BE REMOVED)
    25 
    26 == doctest_continuation ==
    27 
    28 Check that doctest continuation use the correct syntax, namely {{{....:}}}
    29 
    30 == foreign_latex ==
    31 
    32 Check that some bad latex code does not appear.
    33 
    34 This means {{{\choose, \over, \atop, \above, \overwithdelims, \atopwithdelims, \abovewithdelims}}}.
    35 
    36 All these commands are obsolete in latex.
    37 
    38 == deprecation_number ==
    39 
    40 Check that new deprecations use the correct ticket number.
     10See definitions in [[https://github.com/sagemath/sage/blob/develop/src/.relint.yml|src/.relint.yml]]
    4111
    4212== python3_py ==
     
    865612) {{{sagenb}}} (the legacy notebook is deprecated)
    8757
    88 == pyflakes ==
     58== foreign_latex ==
    8959
    90 Run `pyflakes` on the modified `.py` files.
     60Check that some bad latex code does not appear.
    9161
    92 This typically reports about unused variables or imports, that you should remove.
     62This means {{{\choose, \over, \atop, \above, \overwithdelims, \atopwithdelims, \abovewithdelims}}}.
    9363
    94 Sometimes it gives false-positive warnings.
    95 
    96 == pycodestyle ==
    97 
    98 Run `pycodestyle` on the modified `.py` files.
    99 
    100 Currently, the selected options are {{{W605, E401, E701, E702, E711, E712}}}.
    101 
    102 See [[http://pycodestyle.pycqa.org/en/latest/intro.html#error-codes|pycodestyle documentation]] for more information.
     64All these commands are obsolete in latex.
    10365
    10466== blocks ==
     
    12183
    12284Look for the presence of triple colons {{{:::}}} or {{{: ::}}}
     85
     86
     87= other patchbot plugins =
     88
     89
     90== commit_messages ==
     91
     92Check for the existence of a commit message for every commit.
     93
     94== coverage ==
     95
     96Try to check that coverage did increase.
     97
     98The coverage is the percent of functions that are doctested. This must be 100%.
     99
     100== non_ascii ==
     101
     102Look for the presence of non-ascii characters in python and cython files.
     103
     104This detects the presence of the encoding line at the top of files. (TO BE REMOVED)
     105
     106== doctest_continuation ==
     107
     108Check that doctest continuation use the correct syntax, namely {{{....:}}}
     109
     110
     111== deprecation_number ==
     112
     113Check that new deprecations use the correct ticket number.
     114
     115== pyflakes ==
     116
     117Run `pyflakes` on the modified `.py` files.
     118
     119This typically reports about unused variables or imports, that you should remove.
     120
     121Sometimes it gives false-positive warnings.
     122
     123== pycodestyle ==
     124
     125Run `pycodestyle` on the modified `.py` files.
     126
     127Currently, the selected options are {{{W605, E401, E701, E702, E711, E712}}}.
     128
     129See [[http://pycodestyle.pycqa.org/en/latest/intro.html#error-codes|pycodestyle documentation]] for more information.
    123130
    124131== trac_links ==