From bc92582a875ba0ebf40eae249b71c1d70cda8795 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20Ma=C5=9Blanka?= <piotr.maslanka@ericsson.com>
Date: Thu, 4 Apr 2024 09:24:50 +0200
Subject: [PATCH] docs fixed
---
.readthedocs.yaml | 10 ++++++++++
docs/basics.rst | 21 +++++++++++++++++++++
2 files changed, 31 insertions(+)
create mode 100644 .readthedocs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..1e246be
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,10 @@
+version: 2
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.9"
+sphinx:
+ configuration: docs/conf.py
+python:
+ install:
+ - requirements: docs/requirements.txt
diff --git a/docs/basics.rst b/docs/basics.rst
index 5f80ace..76b9fe8 100644
--- a/docs/basics.rst
+++ b/docs/basics.rst
@@ -18,3 +18,24 @@ and receive them
.. autoclass:: coolamqp.objects.ReceivedMessage
:members:
+
+MessageProperties
+-----------------
+
+.. autoclass:: coolamqp.objects.MessageProperties
+ :members:
+
+.. autoclass:: coolamqp.framing.definitions.BasicContentPropertyList
+ :members:
+ :undoc-members:
+
+
+Take care, as :class:`~coolamqp.objects.MessageProperties` will hash the
+entire object (keys and values) and store it within non-GCable memory.
+
+This is done in order to facilitate reuse and speed/memory consumption.
+If you're looking forward to shipping each message with different properties,
+please wait until #51_ is fixed.
+
+.. _#51: https://github.com/smok-serwis/coolamqp/issues/51
+
--
GitLab