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] Update emulated analog docs #166

Merged
merged 51 commits into from
Nov 8, 2023
Merged

[Docs] Update emulated analog docs #166

merged 51 commits into from
Nov 8, 2023

Conversation

jpmoutinho
Copy link
Collaborator

@jpmoutinho jpmoutinho commented Nov 7, 2023

  • In the new docs we don't explain the add_interaction function, but instead hide it, with the goal being that it will not be user facing in the next refactors. If we agree, this closes add_interaction explanation in the documentation #132 .
  • Regarding [Refactoring, DA, Documentation] AnalogRX's blockade radius #108, we now make it explicit what each Analog function is doing, and it should be clear that AnalogRot should be used to have full control over the parameters. The goal is to improve this in the next refactors. For now we can either close this issue or leave it open until the refactors are done.

Closes #138.

fix
@jpmoutinho jpmoutinho marked this pull request as ready for review November 8, 2023 13:11
@jpmoutinho jpmoutinho self-assigned this Nov 8, 2023
Copy link
Collaborator

@nmheim nmheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big fan of what is happening here. Thanks a lot! Just a few very nitpicky comments:)

docs/digital_analog_qc/analog-qcl.md Outdated Show resolved Hide resolved
docs/digital_analog_qc/analog-basics.md Show resolved Hide resolved
docs/digital_analog_qc/analog-basics.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@RolandMacDoland RolandMacDoland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments from me. Otherwise looking good. Thanks

docs/digital_analog_qc/analog-qcl.md Outdated Show resolved Hide resolved
docs/digital_analog_qc/analog-qcl.md Show resolved Hide resolved
docs/tutorials/register.md Outdated Show resolved Hide resolved
docs/tutorials/register.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@RolandMacDoland RolandMacDoland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments from me. Otherwise looking good. Thanks

fix
@jpmoutinho jpmoutinho merged commit c4f5887 into main Nov 8, 2023
7 checks passed
@jpmoutinho jpmoutinho deleted the jm/emu_docs branch November 8, 2023 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better documentation on how to work with interactions add_interaction explanation in the documentation
3 participants