X-Git-Url: https://mudpy.org/gitweb?p=mudpy.git;a=blobdiff_plain;f=doc%2Fsource%2Fcoder.rst;h=25493b05e685ff6609872dd51d286141ce7985dd;hp=1104bcac1c72c7734667d1361ab3e62917105c95;hb=3326b026aaa08da286dae464ff4daab7f583e3d0;hpb=59d19f318a91105f4d02c91946e6032df307a6e9 diff --git a/doc/source/coder.rst b/doc/source/coder.rst index 1104bca..25493b0 100644 --- a/doc/source/coder.rst +++ b/doc/source/coder.rst @@ -2,10 +2,9 @@ coder guide ============= -.. Copyright (c) 2004-2018 Jeremy Stanley . - Permission to use, copy, modify, and distribute this software is - granted under terms provided in the LICENSE file distributed with - this software. +.. Copyright (c) 2004-2019 mudpy authors. Permission to use, copy, + modify, and distribute this software is granted under terms + provided in the LICENSE file distributed with this software. This guide attempts to embody a rudimentary set of rules for developer submissions of source code and documentation targeted for inclusion @@ -29,9 +28,9 @@ presentation and discussion of patches soon. A :file:`ChangeLog` is generated automatically from repository commit logs, and is included automatically in all sdist_ tarballs. It -can be regenerated easily by running :command:`tox -e venv python -setup.py sdist` from the top level directory of the Git repository in -a working `developer environment`_. +can be regenerated easily by running :command:`tox -e dist` from the +top level directory of the Git repository in a working `developer +environment`_. .. _Git: https://git-scm.com/ .. _sdist: https://packaging.python.org/glossary @@ -44,15 +43,17 @@ Basic developer requirements are a POSIX Unix derivative (such as Linux), a modern Python 3 interpreter (any of the minor revisions mentioned in the ``metadata.classifier`` section of :file:`setup.cfg`) and a recent release of the tox_ utility (at least -the ``tox.minversion`` mentioned in :file:`tox.ini`). +the ``tox.minversion`` mentioned in :file:`tox.ini`). The tox-venv_ +plug-in for tox is also recommended. .. _tox: https://tox.readthedocs.io/ +.. _tox-venv: https://pypi.org/project/tox-venv/ application program interface ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -API documentation is maintained within docstrings in the mudpy source -code. +The :doc:`api` API documentation is maintained within docstrings in +the mudpy source code. regression testing ~~~~~~~~~~~~~~~~~~