From 205de99eaa199d4a2a345baa3520401849c9e2b8 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Wed, 4 Nov 2020 15:44:08 +0100
Subject: [PATCH] docs(config): Improve config module documentation
Slight formatting cleanup to ensure the docs are rendered and linked
properly.
Signed-off-by: Rahix <rahix@rahix.de>
---
pycardium/modules/py/config.py | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/pycardium/modules/py/config.py b/pycardium/modules/py/config.py
index 8d70936ff..7fae24c95 100644
--- a/pycardium/modules/py/config.py
+++ b/pycardium/modules/py/config.py
@@ -6,22 +6,22 @@ def set_string(key, value):
Write a string to the configuration file ``card10.cfg``.
Both ``key`` and ``value`` must be strings or must be
- convertible to a string using the ``str()`` function.
+ convertible to a string using the :py:func:`str()` function.
``key`` must not contain spaces, control characters (including tabs),
number signs ans equal signs.
- ``value` must not contain control characters (including tabs).
- Neither is allowed to contain the sub-string ``execute_elf``.
+ ``value`` must not contain control characters (including tabs).
+ Neither is allowed to contain the sub-string ``"execute_elf"``.
The key/value pair is immediately written to the configuration
file (``card10.cfg``). After the file is written, configuration
- is read again and the new value is available via ``config.get_string``.
+ is read again and the new value is available via :py:func:`config.get_string`.
:param str key: Name of the configuration option.
:param str value: Value to write.
:raises OSError: If writing to the configuration file failed.
:raises OSError: If key or value contain illegal characters.
- :raises ValueError: If key or value contain the sub-string ``execute_elf``.
+ :raises ValueError: If key or value contain the sub-string ``"execute_elf"``.
.. versionadded:: 1.16
"""
@@ -34,7 +34,7 @@ def get_string(key):
Read a string from the configuration file ``card10.cfg``.
``key`` must be a string or must be convertible to a string using
- the ``str()`` function.
+ the :py:func:`str()` function.
:param str key: Name of the configuration option.
--
GitLab