Automatic Update

Tue Sep  5 19:51:15 UTC 2023

_sources/development.rst.txt

@@ -94,21 +94,18 @@ master.
 Linting
 =======
 
-The linting processes are configured and run with `pre-commit <https://pre-commit.com>`_. Using pre-commit provides
-a single file ( ".pre-commit-config.yaml" ) configuration for both execution of CI and local git pre-commit hooks. The
-"pre-commit" package does not need to be installed in the projects venv. Once initialized for the project, pre-commit
-will manage the versions of the tools in a separate environment, that is automatically managed.
-
-The following is the `quick start guide <https://pre-commit.com/#quick-start>`_.
-
 The linting process uses both `Black <https://black.readthedocs.io/en/stable/>`_  and
-`flake8 <https://flake8.pycqa.org/en/latest/>`_ to ensure uncompromising code formatting and identify programmatic
-problems. The black code formatting tool must be used to auto format new code before committing:
+`flake8 <https://flake8.pycqa.org/en/latest/>`_ to ensure uncompromising code formatting and some programmatic problems.
+The Black must be used to auto format new code before committing. As the continuous integration enforces black style, it
+can safely be run on the whole repository without changing old code:
 
 .. code:: bash
 
     python -m black .
 
+
+Black is installed as part for the development requirements.
+
 As part of the linting process the secret scanner `tufflehog3 <https://github.com/feeltheajf/truffleHog3>`_ is also
 used.
 

development.html

@@ -110,17 +110,14 @@ <h2>Contributing<a class="headerlink" href="#contributing" title="Link to this h
 master.</p>
 <section id="linting">
 <h3>Linting<a class="headerlink" href="#linting" title="Link to this heading">¶</a></h3>
-<p>The linting processes are configured and run with <a class="reference external" href="https://pre-commit.com">pre-commit</a>. Using pre-commit provides
-a single file ( “.pre-commit-config.yaml” ) configuration for both execution of CI and local git pre-commit hooks. The
-“pre-commit” package does not need to be installed in the projects venv. Once initialized for the project, pre-commit
-will manage the versions of the tools in a separate environment, that is automatically managed.</p>
-<p>The following is the <a class="reference external" href="https://pre-commit.com/#quick-start">quick start guide</a>.</p>
 <p>The linting process uses both <a class="reference external" href="https://black.readthedocs.io/en/stable/">Black</a>  and
-<a class="reference external" href="https://flake8.pycqa.org/en/latest/">flake8</a> to ensure uncompromising code formatting and identify programmatic
-problems. The black code formatting tool must be used to auto format new code before committing:</p>
+<a class="reference external" href="https://flake8.pycqa.org/en/latest/">flake8</a> to ensure uncompromising code formatting and some programmatic problems.
+The Black must be used to auto format new code before committing. As the continuous integration enforces black style, it
+can safely be run on the whole repository without changing old code:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>black<span class="w"> </span>.
 </pre></div>
 </div>
+<p>Black is installed as part for the development requirements.</p>
 <p>As part of the linting process the secret scanner <a class="reference external" href="https://github.com/feeltheajf/truffleHog3">tufflehog3</a> is also
 used.</p>
 </section>