| Title | Source code documentation is inadequate |
| Status | closed |
| Priority | optional |
| Assigned user | Richard Brooksby |
| Organization | Ravenbrook |
| Description | The documentation in comments in the source code is generally inadequate. Each source code file should conform to the general rules. There needs to be more cross-referencing to design documents. |
| Analysis | A thorough going over of the sources to update design documents and add cross-references is needed. The Bugzilla patches need to be cross-referenced to the Python sources. |
| How found | inspection |
| Evidence | Noticed while working on branch p4dti/branch/2000-12-08/config-reorg. |
| Created by | Richard Brooksby |
| Created on | 2000-12-13 12:12:29 |
| Last modified by | Gareth Rees |
| Last modified on | 2001-12-10 19:14:06 |
| History | 2000-12-13 RB Created. |