Adding documentation on link types #1174
Conversation
| The links of the graph are arrows connecting two nodes. An arrow (x, y) is | ||
| considered to be directed from x to y; y is called the **head** and x is called | ||
| the **tail** of the arrow; y is said to be a **direct successor** of x and x | ||
| is said to be a **direct predecessor** of y. If a path leads from x to y, then |
There was a problem hiding this comment.
I'm not sure if we want to add the discussion on direct successor or predecessor, it is not needed for this page, and I think it introduces a new "language" that we never use elsewhere...
There was a problem hiding this comment.
It's true. I had the same feeling and I mainly added it because I need it for the discussion on the export that will follow (and it would be late to be mentioned at that point).
As a general comment, I would say that it would be good to follow (or start following?) the terminology of the domain that we focus on. E.g. for the moment we use input/output and ancestor/descendant that seemed natural to us (at least this is my understanding). For trees, which are DAGS, it is used parent/child & ancestor/descendant to refer to the same relationships. At https://en.wikipedia.org/wiki/Directed_graph where they talk about directed graphs (which is what we have now) they talk about (direct/indirect) predecessor /successors.
docs/source/link_types/index.rst
Outdated
| of the link, and they are documented at the | ||
| :doc:`QueryBuilder section <../querying/querybuilder/usage>`. For example, | ||
| if there is an **INPUT** link from data D to calculation C, D is the | ||
| “input_of” C, or equivalently D is the “output_of” C. |
There was a problem hiding this comment.
Probably we can add "Currently, in the QueryBuilder, input_of and output_of refer to any link type, where C is the tail of the arrow and D is the head."
This is the documentation on the link types.
Please let me know if I should add something more or if something is not clear. When this is merged, I will also send the email on the export node set population based on the links.
I will also put this commit at the 0.11.1 branch but I want it also in develop in order to appear directly at the online documentation./