diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2025-05-14 18:47:36 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2025-06-04 13:46:28 -0400 |
| commit | d120a313b75a41e6d3ae1f53cda9dbd6e1d31615 (patch) | |
| tree | 2af415dd787f570c7294cfdc0413c765a7f06dc3 /docs | |
| parent | 4d4b9684a53fa7e776914b222cdab21f870dad76 (diff) | |
| download | kutter-d120a313b75a41e6d3ae1f53cda9dbd6e1d31615.tar.gz kutter-d120a313b75a41e6d3ae1f53cda9dbd6e1d31615.tar.xz kutter-d120a313b75a41e6d3ae1f53cda9dbd6e1d31615.zip | |
docs: Note 'config' object shouldn't be accessed after initial load
Update Code_Overview.md to note that the config object should not be
stored after the "config loading phase".
Remove a few inadvertent cases where a 'config' object was stored
in module member variables.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Code_Overview.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/Code_Overview.md b/docs/Code_Overview.md index 9ccaa60b..fd0e90a3 100644 --- a/docs/Code_Overview.md +++ b/docs/Code_Overview.md @@ -286,6 +286,11 @@ The following may also be useful: during the `load_config()` or "connect event" phases. Use either `raise config.error("my error")` or `raise printer.config_error("my error")` to report the error. +* Do not store a reference to the `config` object in a class member + variable (nor in any similar location that may persist past initial + module loading). The `config` object is a reference to a "config + loading phase" class and it is not valid to invoke its methods after + the "config loading phase" has completed. * Use the "pins" module to configure a pin on a micro-controller. This is typically done with something similar to `printer.lookup_object("pins").setup_pin("pwm", |