From d45b9463274b068688b519cf4d82b406c517ac3d Mon Sep 17 00:00:00 2001
From: Tim Schoof <tim.schoof@desy.de>
Date: Mon, 27 May 2024 16:59:11 +0200
Subject: [PATCH] Included suggestions
---
docs/site/docs/consumer-clients.md | 6 +++---
docs/site/docs/producer-clients.md | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/site/docs/consumer-clients.md b/docs/site/docs/consumer-clients.md
index b4f597d53..9413999f3 100644
--- a/docs/site/docs/consumer-clients.md
+++ b/docs/site/docs/consumer-clients.md
@@ -14,12 +14,12 @@ Consumer API is available for C++ and Python and has the following main function
- A beamtime token is used for access control
- If needed (mainly for 'get_next_XX' operations), create a consumer group that allows to process messages independently from other groups
- Receive messages from a specific stream (you can read more [here](data-in-asapo) about data in ASAPO)
- - 'get_next' to receive process messages one after another without need to know message indexes
+ - `get_next` to receive process messages one after another without need to know message indexes
- Consumer API returns a message with index 1, then 2, ... as they were set by producer.
- This also works in parallel so that the payload is distributed within multiple consumers within same consumer group or between threads of a single consumer instance. In parallel case order of indexes of the messages is not determined.
- Optionaly it can return messages in their arrival order (return next available message). It is useful for the fast data-processing agnostic to message index.
- - 'get_last' to receive last available message - for e.g. live visualisation
- - 'get_by_id' to get message by index, providing random access
+ - `get_last` to receive last available message - for e.g. live visualisation
+ - `get_by_id` to get message by index, providing random access
- Make queries based on metadata contained in a message - returns all messages in a stream with specific metadata. A subset of SQL language is used
diff --git a/docs/site/docs/producer-clients.md b/docs/site/docs/producer-clients.md
index 1d8dd4f2b..a606bdd39 100644
--- a/docs/site/docs/producer-clients.md
+++ b/docs/site/docs/producer-clients.md
@@ -2,7 +2,7 @@
title: Producer Clients
---
-Producer client (or producer) is a part of a distributed streaming system that is responsible for creating data streams (i.e. ingesting data in the system). It is usually a user (beamline scientist, detector developer, physicist, ... ) responsibility to develop a client for specific beamline, detector or experiment using ASAPO Producer API and ASAPO's responsibility to make sure data is transferred and saved an in efficient and reliable way.
+Producer client (or producer) is a part of a distributed streaming system that is responsible for creating data streams (i.e. ingesting data in the system). It is usually a user's (beamline scientist, detector developer, physicist, ... ) responsibility to develop a client for specific beamline, detector or experiment using ASAPO Producer API and ASAPO's responsibility to make sure data is transferred and saved an in efficient and reliable way.
--
GitLab