doc: explain better the "submulti" status for a follower #15

Open
opened 2024-06-04 11:20:50 +02:00 by gremond · 0 comments
Member

This part of the documentation :

https://rougail.readthedocs.io/en/latest/family.html#follower-variable

is not speaking at all, in the code it is the concept of submulti, in the doc it is not obvious. Maybe a concrete example of a "multi of multi" could be usefull here.

For example, let's say we have a database. More precisely, we have multiple databases.

The leader variable describes one (or many) database names.
The follower variable describes the list of users of a database.

We see clearly in this example that

  • a database needs a list of users
  • another database needs another list of users.

The follower variable is a list (the list of users) of list (for each database).

Moreover, a the follower variable shall not be a unique value but shall keep as a list. This is the keypoint.

This part of the documentation : https://rougail.readthedocs.io/en/latest/family.html#follower-variable is not speaking at all, in the code it is the concept of `submulti`, in the doc it is not obvious. Maybe a concrete example of a "multi of multi" could be usefull here. For example, let's say we have a database. More precisely, we have multiple databases. The leader variable describes one (or many) database names. The follower variable describes the list of users of a database. We see clearly in this example that - a database needs a list of users - another database needs another list of users. The follower variable is a list (the list of users) of list (for each database). Moreover, a the follower variable shall not be a unique value but shall keep as a list. This is the keypoint.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: stove/rougail#15
No description provided.