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: Updated Readme and docstrings #7

Merged
merged 12 commits into from
Aug 30, 2024
Merged

Conversation

u625355
Copy link
Contributor

@u625355 u625355 commented Aug 29, 2024

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 apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Functionality update (non-breaking change which updates or changes existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • CI/CD update (an update to the CI/CD workflows, scripts, and/or configurations)
  • Documentation update (an update to enhance the user experience when reading through the docs)

Checklist

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.

  • [x I have followed the guidelines in the CONTRIBUTING document
  • I have signed the CLA
  • I have checked to ensure there aren't other open Pull Requests for the same update/change
  • I have created (or updated) an Issue to track the status of this update/change and updated the link in this PR description (see above in the Proposed changes section) using the wording Addresses #<issue_number>
  • I have performed a self-review of my code
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • Basic linting passes locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added necessary documentation (if appropriate)
  • I have updated the Changelog with a brief description of my changes

@u625355 u625355 requested a review from a team as a code owner August 29, 2024 15:15
docs/glossary.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
src/tm_data_types/datum/data_types.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@nfelt14 nfelt14 requested review from tekperson and qthompso August 29, 2024 15:31
@u625355 u625355 requested a review from nfelt14 August 29, 2024 19:23
docs/basic_usage.md Show resolved Hide resolved
docs/basic_usage.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

@tekperson tekperson left a 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.

@u625355
Copy link
Contributor Author

u625355 commented Aug 30, 2024

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.

@u625355 u625355 requested a review from nfelt14 August 30, 2024 05:48
@u625355 u625355 force-pushed the shashank55/misc-updates branch from 3ce79b6 to 3b3bd6d Compare August 30, 2024 06:17
@u625355 u625355 enabled auto-merge (squash) August 30, 2024 06:25
README.md Outdated Show resolved Hide resolved
docs/advanced/writing_to_a_file.md Outdated Show resolved Hide resolved
docs/glossary.md Outdated Show resolved Hide resolved
docs/macros.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@u625355 u625355 requested a review from nfelt14 August 30, 2024 18:22
docs/glossary.md Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
src/tm_data_types/io_factory_methods.py Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@u625355 u625355 requested a review from nfelt14 August 30, 2024 19:07
@nfelt14 nfelt14 disabled auto-merge August 30, 2024 19:59
@nfelt14 nfelt14 merged commit 1cb202f into main Aug 30, 2024
1 check failed
@nfelt14 nfelt14 deleted the shashank55/misc-updates branch August 30, 2024 20:00
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.

3 participants