Relocate wiki from trac

This commit is contained in:
rot
2023-01-25 13:36:26 +01:00
committed by h7x4
parent 36146893e6
commit d52dbbd9be
23 changed files with 781 additions and 0 deletions

14
wiki/development/hints.md Normal file
View File

@@ -0,0 +1,14 @@
# Development hints
## Terminology
Read terminology for the conventions used in the program. This ensures a consistent use of terms within the program. New terminology should be described on the that page, and should be introduced only when needed. Too much terminology clutters the namespace.
## Logging
Log output is very easy. Import the logger module, and use the singleton Logger instance inside it. The logger has four different debug levels, debug, notice, warning and error. A simple example follows:
```python
import logger
logger.log('debug', 'This should appear in the log window as a debug message')
```

19
wiki/development/names.md Normal file
View File

@@ -0,0 +1,19 @@
## Recommended names
### Variables
- fn for filenames.
- fd for files.
- dim for a dimension.
- it for iterators.
- ids for a list of identifiers.
- indices
- func for functions
### Function handlers
Function handlers should generally be named _on_<signal>. This makes them private and easy to follow. This is not an absolute rule, as there can be several functions in the same namespace listening to the same signal, but on different objects.
## Unrecommended names
- iter
- dimname, dim_name etc.