Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 892 Bytes

index.rst

File metadata and controls

47 lines (34 loc) · 892 Bytes

Standards

Coding Standards

Coding standards are vital for creating a maintainable and extensible system. However in order for them to be effective they have to be accepted and supported by the entire development team.

Code produced by code generators is not covered directly by this procedure. Programmers must apply the underlying principles of this procedure in a sensible manner to code generated automatically.

.. toctree::
   :maxdepth: 1

   MantidStandards
   CPPModernization
   CPPStandards
   GUIStandards
   PythonStandards
   UnitTestStandards

Documentation Standards

.. toctree::
   :maxdepth: 1

   DocumentationGuideForDevs
   AlgorithmDocumentation
   AlgorithmUsageExamples
   InterfaceDocumentation


Guidelines

.. toctree::
   :maxdepth: 1

   Libraries
   AdditionalPythonCode