summaryrefslogtreecommitdiff
path: root/docutils/docs
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-11-07 17:40:24 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-11-07 17:40:24 +0000
commit5e7c6c3ce5835b59f058b12205ab9e1c1e63da78 (patch)
tree2dc9c514493707626e1b263316d19032cdb9c655 /docutils/docs
parentfc59cfc7455fd34ab1e293b4e5ac54cffbc7502f (diff)
downloaddocutils-5e7c6c3ce5835b59f058b12205ab9e1c1e63da78.tar.gz
Update/clarify documentation/docstrings.
After dropping support for Python2, we can use the datatype named `bytes` and `str` for encoded strings and Unicode strings respectively. Use the "summary line + optional explanations" style mandated in the "Docstring Conventions" (PEP 257). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9221 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs')
-rw-r--r--docutils/docs/user/config.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index dd1d02f80..289974647 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -417,6 +417,10 @@ output_encoding
The text encoding for output.
+The "output_encoding" setting may also affect the content of the output
+(e.g. an encoding declaration in HTML or XML or the representation of
+characters as LaTeX macro vs. literal character).
+
Default: "utf-8". Options: ``--output-encoding, -o``.
output_encoding_error_handler