Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requests for clarifications & additional documentation #1015

Open
Ellpeck opened this issue Sep 25, 2024 · 0 comments
Open

Requests for clarifications & additional documentation #1015

Ellpeck opened this issue Sep 25, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Ellpeck
Copy link
Member

Ellpeck commented Sep 25, 2024

This is a list of things I still struggle to understand and that, especially for other users of the API, should be documented better if possible. Some of these may already be documented and I just missed or misunderstood them.

  • What are we meant to do when we feel we lack some (complex) fundamental piece of understanding about how flowR works? Is the original master's thesis still the place to get that information, since it appears to be so far removed from flowR's current architecture?
  • Clearer link between the new dataflow docs (which are very good so far) and the typescript api. Specifically things like how to get related edges and nodes of specific types, for example: retrieving the condition/true/false branches of a node that represents an if call.
  • I feel that some explanations in the dataflow doc have phrasing that is too complex. This may just be an issue with my personal understanding & lack of experience, but for example, when reading the sentence "The source vertex is usually a define variable that is defined by the respective target use", the following questions come up for me:
    • What's a "define variable" in this context?
    • What's a "target use"? Is this sentence even using "target use" as a noun like in my understanding of the phrasing?
  • More info about control dependencies, like what all is marked as one and why.
  • Sometimes I struggle to instinctually understand the meaning of an edge direction, especially for edge types like argument that don't imply directionality in their name (whereas "defined by", for example, is clearer because you can read it as "x is defined by ->").
@Ellpeck Ellpeck added the documentation Improvements or additions to documentation label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants