diff options
Diffstat (limited to 'doc/python/sphinx/glossary.rst')
-rw-r--r-- | doc/python/sphinx/glossary.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/python/sphinx/glossary.rst b/doc/python/sphinx/glossary.rst new file mode 100644 index 0000000000..dee5d16143 --- /dev/null +++ b/doc/python/sphinx/glossary.rst @@ -0,0 +1,16 @@ +Glossary +================ + +.. glossary:: + + metadatum + A key-value pair included in the HTTP header. It is a + 2-tuple where the first entry is the key and the + second is the value, i.e. (key, value). The metadata key is an ASCII str, + and must be a valid HTTP header name. The metadata value can be + either a valid HTTP ASCII str, or bytes. If bytes are provided, + the key must end with '-bin', i.e. + ``('binary-metadata-bin', b'\\x00\\xFF')`` + + metadata + A sequence of metadatum. |