summaryrefslogtreecommitdiff
path: root/plugins/pychrysalide/core/module.c
diff options
context:
space:
mode:
authorCyrille Bagard <nocbos@gmail.com>2020-01-04 10:15:57 (GMT)
committerCyrille Bagard <nocbos@gmail.com>2020-01-04 10:15:57 (GMT)
commitaded4e75efc21319d5a777bf53bc087587f0740c (patch)
tree8b1b11415227679c79272cfb1df90f13801bb219 /plugins/pychrysalide/core/module.c
parent8255d60ac64a851c2e7ca37d63aa1ba37d35b704 (diff)
Refreshed the Python documentation for the core features.
Diffstat (limited to 'plugins/pychrysalide/core/module.c')
-rw-r--r--plugins/pychrysalide/core/module.c11
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins/pychrysalide/core/module.c b/plugins/pychrysalide/core/module.c
index d954821..27113a0 100644
--- a/plugins/pychrysalide/core/module.c
+++ b/plugins/pychrysalide/core/module.c
@@ -55,12 +55,21 @@ bool add_core_module(PyObject *super)
bool result; /* Bilan à retourner */
PyObject *module; /* Sous-module mis en place */
+#define PYCHRYSALIDE_CORE_DOC \
+ "This module provides access to the Chrysalide core properties through" \
+ " the Python bindings.\n" \
+ "\n" \
+ "Most of these features are singleton objects.\n" \
+ "\n" \
+ "As attributes are not allowed for Python modules, all these" \
+ " property accesses are handled with methods."
+
static PyModuleDef py_chrysalide_core_module = {
.m_base = PyModuleDef_HEAD_INIT,
.m_name = "pychrysalide.core",
- .m_doc = "Python module for Chrysalide.core",
+ .m_doc = PYCHRYSALIDE_CORE_DOC,
.m_size = -1,