@@ -51,7 +51,7 @@ Before you submit a pull request, check that it meets these guidelines:
51
51
1. The pull request should include tests.
52
52
2. If the pull request adds functionality, the docs should be updated. Put
53
53
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`` .
55
55
3. Check https://travis-ci.org/qucontrol/qdynpylib/pull_requests
56
56
and make sure that the tests pass for all supported Python versions.
57
57
@@ -98,12 +98,13 @@ You still can (and should) look at https://travis-ci.org/qucontrol/qdynpylib/ to
98
98
99
99
.. _conda : https://conda.io/docs/
100
100
101
-
102
101
.. _Aaron Meurer's Git Workflow Notes : https://www.asmeurer.com/git-workflow/
103
102
104
103
.. _qucontrol organization : https://github.com/qucontrol
105
104
106
105
106
+ .. _BranchingModel :
107
+
107
108
Branching Model
108
109
---------------
109
110
@@ -224,7 +225,7 @@ QDYN-pylib includes a full test-suite using pytest_.
224
225
We strive for a `test coverage `_ above 90%.
225
226
226
227
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
228
229
229
230
.. code-block :: console
230
231
@@ -351,8 +352,6 @@ The following assumes your current working directory is a checkout of
351
352
``qdyn ``, and that you have successfully run ``make test `` (which creates
352
353
some local virtual environments that development relies on).
353
354
354
- .. _how-to-work-on-a-topic-branch :
355
-
356
355
357
356
How to install QuTiP from source ("illegal instruction" in QuTiP conda install)
358
357
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -400,7 +399,7 @@ How to run a jupyter notebook server for working on notebooks in the docs
400
399
401
400
A notebook server that is isolated to the proper testing environment can be started via the Makefile::
402
401
403
- $ make jupter -notebook
402
+ $ make jupyter -notebook
404
403
405
404
This is equivalent to::
406
405
@@ -414,7 +413,7 @@ course, if you know what you're doing, you may want this.
414
413
415
414
If you prefer, you may also use the newer jupyterlab::
416
415
417
- $ make jupter -lab
416
+ $ make jupyter -lab
418
417
419
418
420
419
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
447
446
form of `test-driven development `_, you have two options:
448
447
449
448
* 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
451
450
adding commits to the same branch.
452
451
453
452
* Mark the test as failing. For normal tests, add a decorator::
0 commit comments