Skip to content
Update Rules authored by Christoph Deneke's avatar Christoph Deneke
......@@ -21,9 +21,9 @@ We have a set of reserved variables that should be used throughout the project:
| sid, s_id| ESS IDs | None |
| mid, m_id | PPM IDs| None|
| rid, r_id | Report IDs | None |
|did, d_id | Document ids | NOne |
| pid, pId | parent dicument ids | None |
| sample | ESS databse record | sample.create (new_sample) |
|did, d_id | Document ids | None |
| pid, pId | parent document ids | None |
| sample | ESS database record | sample.create (new_sample) |
| measurement | PPM database record | measurements.create |
| report | Report database entry | report.create |
| user | User database entry | some like new_user, s_user |
......@@ -41,6 +41,6 @@ Beside this, more relaxed, the use of following things is suggested:
All functions should have a docsstring following the [numpy style](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).
We encourage to do typing of the variable inside the docstring. We use sphinx to automatically create a html documentation of the API. Needs more work and improvement. To make our life easier, we use markdown files for sphinx.
We encourage to do typing of the variable inside the docstring. We use sphinx to automatically create a HTML documentation of the API. Needs more work and improvement. To make our life easier, we use markdown files for sphinx.
We use the read_the_docs theme as it makes much nicer output.
\ No newline at end of file