Skip to content

docs: Document API changes and new classes. #69

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 3, 2024
Merged

docs: Document API changes and new classes. #69

merged 1 commit into from
Apr 3, 2024

Conversation

iabdalkader
Copy link
Collaborator

@iabdalkader iabdalkader commented Mar 28, 2024 •
edited
Loading

Fixes #66

@iabdalkader iabdalkader force-pushed the update_docs branch 2 times, most recently from ae81c36 to a6e612e Compare March 28, 2024 15:39
@leonardocavagnis leonardocavagnis linked an issue Mar 28, 2024 that may be closed by this pull request
Doc missing for AdvancedADCDual #66
Closed
leonardocavagnis
leonardocavagnis requested changes Mar 28, 2024
View reviewed changes
Copy link
Contributor

@leonardocavagnis leonardocavagnis left a comment

Choose a reason for hiding this comment

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

Everything looks fine.
just a note: start() function doc is missing

@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: documentation Related to documentation for the project labels Mar 28, 2024
@iabdalkader
Copy link
Collaborator Author

just a note: start() function doc is missing

I2S doesn't have a start function, since it doesn't have the start arg like ADC. In IN and INOUT modes it starts on begin, in OUT mode it starts after enough buffers are written to the pool, just like DAC.

@iabdalkader
Copy link
Collaborator Author

I see a few issues in the old API docs that should be fixed, will update this again.

leonardocavagnis
leonardocavagnis requested changes Apr 2, 2024
View reviewed changes
Copy link
Contributor

@leonardocavagnis leonardocavagnis left a comment

Choose a reason for hiding this comment

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

Sorry for misunderstanding! I meant start() of AdvancedADC class 🙂

@iabdalkader iabdalkader merged commit a57630a into main Apr 3, 2024
5 checks passed
@iabdalkader iabdalkader deleted the update_docs branch April 3, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonardocavagnis leonardocavagnis leonardocavagnis approved these changes

Assignees
No one assigned
Labels
topic: documentation Related to documentation for the project type: imperfection Perceived defect in any part of project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Doc missing for AdvancedADCDual
3 participants
@iabdalkader @leonardocavagnis @per1234