Developer documentation¶
See solid_angle_correction.py for propely documented code
Standard variable names and what they denote¶
wavelength
(waswl
) - wavelengthsample_det_cent
(wass2p
) - sample to detector center distancel1
- source to sample distanceneed definitions of
l2
,r1
,r2
,dwl
, … These should likely get different names with unambigious meaningssee e.g. solid_angle_correction.py for properly documented/named code
Random points about coding conventions¶
All code will follow the pep8 standard
Docstrings will use numpy formatting
Code that uses Mantid algorithms will have an addional “Mantid algorithms used” section with links using inter-sphinx
All internal functions should have an underbar, as is python standard
Need more comments in meat of code explaining intent. For example, more clearly named variables (or leave the variables the same but give them better documentation)
The development team still hasn’t decided a standard for how errors/exceptions are handled