From ff0dbdf470db33cc4895a25c279d1835ce7660f6 Mon Sep 17 00:00:00 2001 From: Daniel Harding Date: Sun, 6 Mar 2022 17:58:10 +0300 Subject: [PATCH 1/3] Fix incorrect attribute and class reference markup --- debug_toolbar/panels/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/debug_toolbar/panels/__init__.py b/debug_toolbar/panels/__init__.py index ce6772ec6..168166bc6 100644 --- a/debug_toolbar/panels/__init__.py +++ b/debug_toolbar/panels/__init__.py @@ -87,7 +87,7 @@ def template(self): Template used to render :attr:`content`. Mandatory, unless the panel sets :attr:`has_content` to ``False`` or - overrides `attr`:content`. + overrides :attr:`content`. """ raise NotImplementedError @@ -248,6 +248,6 @@ def run_checks(cls): This will be called as a part of the Django checks system when the application is being setup. - Return a list of :class: `django.core.checks.CheckMessage` instances. + Return a list of :class:`django.core.checks.CheckMessage` instances. """ return [] From ec2634c139b9589eb0dbbc4d298a1dd170f44a50 Mon Sep 17 00:00:00 2001 From: Daniel Harding Date: Mon, 7 Mar 2022 16:03:53 +0300 Subject: [PATCH 2/3] Fix markup for pre-commit install block --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 4b0a867c5..a1245b5dd 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -103,7 +103,7 @@ Style The Django Debug Toolbar uses `black `__ to format code and additionally uses flake8 and isort. The toolbar uses `pre-commit `__ to automatically apply our style -guidelines when a commit is made. Set up pre-commit before committing with: +guidelines when a commit is made. Set up pre-commit before committing with:: $ pre-commit install From bb72bc65187526e740fc7d000cf642350fa66c32 Mon Sep 17 00:00:00 2001 From: Daniel Harding Date: Mon, 7 Mar 2022 16:06:34 +0300 Subject: [PATCH 3/3] Update setup.py references in release instructions When appropriate, update to reference setup.cfg instead. --- docs/contributing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index a1245b5dd..eea9dfa8f 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -152,8 +152,8 @@ The release itself requires the following steps: #. Update supported Python and Django versions: - - ``setup.py`` ``python_requires`` list - - ``setup.py`` trove classifiers + - ``setup.cfg`` ``python_requires`` and ``install_requires`` options + - ``setup.cfg`` trove classifiers - ``README.rst`` Commit. @@ -167,7 +167,7 @@ The release itself requires the following steps: Commit. #. Bump version numbers in ``docs/changes.rst``, ``docs/conf.py``, - ``README.rst``, ``debug_toolbar/__init__.py`` and ``setup.py``. + ``README.rst``, ``debug_toolbar/__init__.py`` and ``setup.cfg``. Add the release date to ``docs/changes.rst``. Commit. #. Tag the new version.