Skip to content
This repository was archived by the owner on Jan 25, 2021. It is now read-only.

Commit 952e0f0

Browse files
committed
Fix typos
1 parent 6a790ab commit 952e0f0

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

CONTRIBUTING.rst

+7-8
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Before you submit a pull request, check that it meets these guidelines:
5151
1. The pull request should include tests.
5252
2. If the pull request adds functionality, the docs should be updated. Put
5353
your new functionality into a function with a docstring, and add the
54-
feature to the list in README.rst.
54+
feature to the list in ``HISTORY.rst``.
5555
3. Check https://travis-ci.org/qucontrol/qdynpylib/pull_requests
5656
and make sure that the tests pass for all supported Python versions.
5757

@@ -98,12 +98,13 @@ You still can (and should) look at https://travis-ci.org/qucontrol/qdynpylib/ to
9898

9999
.. _conda: https://conda.io/docs/
100100

101-
102101
.. _Aaron Meurer's Git Workflow Notes: https://www.asmeurer.com/git-workflow/
103102

104103
.. _qucontrol organization: https://github.com/qucontrol
105104

106105

106+
.. _BranchingModel:
107+
107108
Branching Model
108109
---------------
109110

@@ -224,7 +225,7 @@ QDYN-pylib includes a full test-suite using pytest_.
224225
We strive for a `test coverage`_ above 90%.
225226

226227

227-
From a checkout of the ``qdyn`` repository, assuming conda_ is installed, you can use
228+
From a checkout of the ``qdynpylib`` repository, assuming conda_ is installed, you can use
228229

229230
.. code-block:: console
230231
@@ -351,8 +352,6 @@ The following assumes your current working directory is a checkout of
351352
``qdyn``, and that you have successfully run ``make test`` (which creates
352353
some local virtual environments that development relies on).
353354

354-
.. _how-to-work-on-a-topic-branch:
355-
356355

357356
How to install QuTiP from source ("illegal instruction" in QuTiP conda install)
358357
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -400,7 +399,7 @@ How to run a jupyter notebook server for working on notebooks in the docs
400399

401400
A notebook server that is isolated to the proper testing environment can be started via the Makefile::
402401

403-
$ make jupter-notebook
402+
$ make jupyter-notebook
404403

405404
This is equivalent to::
406405

@@ -414,7 +413,7 @@ course, if you know what you're doing, you may want this.
414413

415414
If you prefer, you may also use the newer jupyterlab::
416415

417-
$ make jupter-lab
416+
$ make jupyter-lab
418417

419418

420419
How to convert a notebook to a script for easier debugging
@@ -447,7 +446,7 @@ would like to commit any example notebooks or tests that currently fail, as a
447446
form of `test-driven development`_, you have two options:
448447

449448
* Push onto a topic branch (which are allowed to have failing tests), see
450-
:ref:`how-to-work-on-a-topic-branch`. The failing tests can then be fixed by
449+
the :ref:`BranchingModel`. The failing tests can then be fixed by
451450
adding commits to the same branch.
452451

453452
* Mark the test as failing. For normal tests, add a decorator::

0 commit comments

Comments
 (0)