Skip to content

Commit

Permalink
dev doc updated
Browse files Browse the repository at this point in the history
  • Loading branch information
kbwestfall committed Feb 5, 2024
1 parent 34f45c2 commit 9bf41ae
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/dev/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,12 @@ are as follows:
* The docstrings for any changes to existing methods that were altered
must have been modified so that they are up-to-date and accurate.

* The documentation must be successfully recompiled, either using the
``update_docs`` scripts or but running ``make clean ; make html`` in the
``doc/`` directory. (We plan for this to be added to the dev-suite testing;
in the meantime, PR authors simply need to affirm that the documentation
builds successfully.)

* Spurious commented code used for debugging or testing is fine, but
please let us know if you want it to be kept by adding a relevant
comment, something like ``# TODO: Keep this around for now``, at the
Expand Down Expand Up @@ -491,7 +497,11 @@ tagging process is as follows:
# Push the new tag
git push --tags
* The tag is released for `pip`_ installation.
Similarly, a matching tag is executed for the dev-suite code (these tags only
exist for versions 1.15 and later).

* The tag of the ``pypeit`` code-base (not the dev-suite) is released for
`pip`_ installation.

.. code-block:: bash
Expand Down

0 comments on commit 9bf41ae

Please sign in to comment.