-
Notifications
You must be signed in to change notification settings - Fork 4
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: Updated Readme and docstrings #7
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the README.md - I don't believe we support Keysight BIN format, and I don't believe we support any specific afg file formats. AFGs have a .wfm, and .xwfm formats. I don't think this code supports either format.
I think it's better to put a statement saying that it's been tested against Tek instruments which indirectly suggest not tested against any other vendor instruments. |
…md file updated with examples and updated src files docstrings.
…on as some of afg's wfm format si not supported.
3ce79b6
to
3b3bd6d
Compare
…docs without links.
…format in table of README.md
Proposed changes
Updated README.md
Updated basic_usage.md to include examples.
Updated mkdocs.yml to include different yml files for docs.
Updated docstrings of src files.
Types of changes
What types of changes does your code introduce?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Addresses #<issue_number>