Skip to content
This repository was archived by the owner on Aug 19, 2023. It is now read-only.

Commit d421d75

Browse files
authored
Fix typos in contributing_to_qiskit.rst (#1351)
* Fix typos in contributing_to_qiskit.rst * Update "below" to "above" The stable branch policy is above * Add a reference to section instead of "above" The stable branch policy section
1 parent 6cdb5c1 commit d421d75

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/contributing_to_qiskit.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Style Guide
7474
===========
7575

7676
To enforce a consistent code style in the project, we use `Pylint
77-
<https://www.pylint.org>`__ and `pycodesytle
77+
<https://www.pylint.org>`__ and `pycodestyle
7878
<https://pycodestyle.readthedocs.io/en/latest/>`__ to verify that code
7979
contributions conform to and respect the project's style guide. To verify that
8080
your changes conform to the style guide, run: ``tox -elint``
@@ -164,7 +164,7 @@ Do not assume the reviewer understands what the original problem was.
164164
When reading an issue, after a number of back & forth comments, it is often
165165
clear what the root cause problem is. The commit message should have a clear
166166
statement as to what the original problem is. The bug is merely interesting
167-
historical background on *how* the problem was identified. It should be
167+
for historical background on *how* the problem was identified. It should be
168168
possible to review a proposed patch for correctness from the commit message,
169169
without needing to read the bug ticket.
170170

@@ -324,6 +324,7 @@ raised by a private method that only has one caller, ``stack_level=3`` might be
324324
appropriate.
325325

326326

327+
.. _stable_branch_policy:
327328

328329
Stable Branch Policy
329330
====================
@@ -519,7 +520,7 @@ documentation from Terra's 0.10.0 release. When the meta-package's requirements
519520
are bumped, then it will start pulling documentation from the new version. This
520521
means that fixes for incorrect API documentation will need to be
521522
included in a new release. Documentation fixes are valid backports for a stable
522-
patch release per the stable branch policy (see that section below).
523+
patch release per the stable branch policy (see :ref:`stable_branch_policy`).
523524

524525
During the build process, the contents of each element's ``docs/apidocs/``
525526
are recursively copied into a shared copy of ``doc/apidocs/`` in the meta-package

0 commit comments

Comments
 (0)