diff options
author | Campbell Barton <campbell@blender.org> | 2022-06-02 12:59:52 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-06-02 13:16:20 +0300 |
commit | 3ca76ae0e8f7cd7f67a352dd3d8a415802506ee2 (patch) | |
tree | ab9358f3d52ef8b2b10bf489c6792bcf6246ef31 /doc/python_api | |
parent | 48bb144feac96e6de8f267417063f4ee0a0de429 (diff) |
Cleanup: remove "<pep8 compliant>" from headers
It can be assumed that all scripts comply with basic pep8 formatting
regarding white-space, indentation etc.
Also remove note in best practices page & update `tests/python/pep8.py`.
If we want to exclude some scripts from make format,
this can be done by adding them to `ignore_files` in:
source/tools/utils_maintenance/autopep8_format_paths.py
Or using `# nopep8` for to ignore for individual lines.
Ref T98554
Diffstat (limited to 'doc/python_api')
-rw-r--r-- | doc/python_api/rst/info_best_practice.rst | 9 | ||||
-rw-r--r-- | doc/python_api/rst_from_bmesh_opdefines.py | 2 | ||||
-rw-r--r-- | doc/python_api/sphinx_changelog_gen.py | 2 | ||||
-rw-r--r-- | doc/python_api/sphinx_doc_gen.py | 2 | ||||
-rw-r--r-- | doc/python_api/sphinx_doc_gen_monkeypatch.py | 2 |
5 files changed, 0 insertions, 17 deletions
diff --git a/doc/python_api/rst/info_best_practice.rst b/doc/python_api/rst/info_best_practice.rst index e88adcc0d70..6342680e149 100644 --- a/doc/python_api/rst/info_best_practice.rst +++ b/doc/python_api/rst/info_best_practice.rst @@ -40,15 +40,6 @@ As well as pep8 we have additional conventions used for Blender Python scripts: - pep8 also defines that lines should not exceed 79 characters, we have decided that this is too restrictive so it is optional per script. -Periodically we run checks for pep8 compliance on Blender scripts, -for scripts to be included in this check add this line as a comment at the top of the script: - -``# <pep8 compliant>`` - -To enable line length checks use this instead: - -``# <pep8-80 compliant>`` - User Interface Layout ===================== diff --git a/doc/python_api/rst_from_bmesh_opdefines.py b/doc/python_api/rst_from_bmesh_opdefines.py index c97b05b96b3..3d8ff1e6248 100644 --- a/doc/python_api/rst_from_bmesh_opdefines.py +++ b/doc/python_api/rst_from_bmesh_opdefines.py @@ -1,7 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-or-later -# <pep8 compliant> - # This is a quite stupid script which extracts bmesh api docs from # 'bmesh_opdefines.c' in order to avoid having to add a lot of introspection # data access into the api. diff --git a/doc/python_api/sphinx_changelog_gen.py b/doc/python_api/sphinx_changelog_gen.py index 6c06178d603..a782c6483b6 100644 --- a/doc/python_api/sphinx_changelog_gen.py +++ b/doc/python_api/sphinx_changelog_gen.py @@ -1,7 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-or-later -# <pep8 compliant> - """ Dump the python API into a text file so we can generate changelogs. diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py index 66bd414f425..8d4320917fc 100644 --- a/doc/python_api/sphinx_doc_gen.py +++ b/doc/python_api/sphinx_doc_gen.py @@ -1,7 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-or-later -# <pep8 compliant> - """ API dump in RST files --------------------- diff --git a/doc/python_api/sphinx_doc_gen_monkeypatch.py b/doc/python_api/sphinx_doc_gen_monkeypatch.py index 09911e9b8a1..e3fba024446 100644 --- a/doc/python_api/sphinx_doc_gen_monkeypatch.py +++ b/doc/python_api/sphinx_doc_gen_monkeypatch.py @@ -1,7 +1,5 @@ # SPDX-License-Identifier: GPL-2.0-or-later -# <pep8 compliant> - bpy_types_Operator_bl_property__doc__ = ( """ The name of a property to use as this operators primary property. |