Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various minor documentation fixes #1592

Merged
merged 3 commits into from
Mar 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions debug_toolbar/panels/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 []
8 changes: 4 additions & 4 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Style
The Django Debug Toolbar uses `black <https://github.com/psf/black>`__ to
format code and additionally uses flake8 and isort. The toolbar uses
`pre-commit <https://pre-commit.com>`__ 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

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down