Skip to content

Commit

Permalink
docs fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrmaslanka committed Apr 4, 2024
1 parent d57ada0 commit bc92582
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions docs/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit bc92582

Please sign in to comment.