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

Docs: "Positive Slack" not defined in RTIO.rst #1084

Closed
drewrisinger opened this issue Jun 28, 2018 · 1 comment
Closed

Docs: "Positive Slack" not defined in RTIO.rst #1084

drewrisinger opened this issue Jun 28, 2018 · 1 comment

Comments

@drewrisinger
Copy link
Contributor

Summary

The RTIO doc is missing a definition for "positive slack", though the term is used. Negative slack is defined on line 167.

Proposed Change

Suggested definition: (i.e. set timeline cursor now greater than the current wall clock rtio_counter)
This definition should be added to Line 169 of RTIO doc, right after the use of positive slack

Reasoning

This should be defined here because this is the first doc most users will read, and it is used extensively in the RTIO Reset section. While it seems trivial, this is a crucial concept and lack of clarity can affect understanding later on when using or developing software for ARTIQ.

@jordens
Copy link
Member

jordens commented Jun 28, 2018

But it says (in L118) RTIO slack is the difference between timeline cursor and wall clock time (now - rtio_counter). right when slack is mentioned the first time. That directly implies that positive slack is equivalent to now > rtio_counter. You are correct, this is a crucial concept. What do you propose?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants