From 2106d9ea9f4f889c9ef2bbe83635379087a3dacf Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Sat, 17 Feb 2018 14:40:09 +0000 Subject: [PATCH] Standardize formatting for the coder guide In preparation for combining existing documentation into a cohesive manual, adjust formatting of the coder guide for consistency with other documents. --- doc/source/coder.rst | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/doc/source/coder.rst b/doc/source/coder.rst index 7f4ddc8..80edcf8 100644 --- a/doc/source/coder.rst +++ b/doc/source/coder.rst @@ -2,28 +2,24 @@ coder guide ============= -:Copyright: (c) 2004-2017 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-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. This guide attempts to embody a rudimentary set of rules for developer submissions of source code and documentation targeted for inclusion within the mudpy project, as well as pointers to useful resources for those attempting to obtain a greater understanding of the software. -.. sectnum:: :prefix: 1. -.. contents:: :local: - --------- - source --------- +source +------ As with any project, the mudpy source code could always be better documented, and contributions to that end are heartily welcomed. version control system ----------------------- +~~~~~~~~~~~~~~~~~~~~~~ Git_ is used for version control on the project, and the archive can be cloned anonymously from http://mudpy.org/git/mudpy if desired. For now, @@ -47,7 +43,7 @@ from the top level directory of the Git repository in a working /#term-source-distribution-or-sdist developer environment ---------------------- +~~~~~~~~~~~~~~~~~~~~~ Basic developer requirements are a POSIX Unix derivative (such as Linux), a modern Python 3 interpreter (any of the minor revisions @@ -59,13 +55,13 @@ a recent release of the tox_ utility (at least the .. _tox.ini: http://mudpy.org/gitweb?p=mudpy.git;a=blob;f=tox.ini application program interface ------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ API documentation is maintained within docstrings in the mudpy source code. regression testing ------------------- +~~~~~~~~~~~~~~~~~~ All new commits are tested using a selftest script in the ``mudpy/tests`` directory of the source archive, to help ensure the @@ -76,9 +72,8 @@ be invoked with ``tox -e selftest`` after starting the daemon with the test configuration provided in the ``mudpy/tests/fixtures`` directory. -------- - style -------- +style +----- This project follows Guido van Rossum and Barry Warsaw's `Style Guide`_ for Python Code (a.k.a. "PEP-8"). When in need of sample code or other -- 2.11.0