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

Updated Documentation in basic_predefined_methods #174

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lucas-tsunaki
Copy link

Description

Following PR #173, the docstrings in the basic_predefined_methods were updated to numpydoc style. Documentation for missing methods were also added. No changes in the code were made.

Types of changes

  • Bug fix
  • New feature
  • Breaking change (Causes existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • I have documented my changes in /docs/changelog.md.
  • My change requires additional/updated documentation.
  • I have updated the documentation accordingly.
  • I have added/updated the config example for any module docstrings as necessary.
  • I have checked that the change does not contain obvious errors
    (syntax, indentation, mutable default values, etc.).
  • I have tested my changes using 'Load all modules' on the default dummy configuration.
  • All changed Jupyter notebooks have been stripped of their output cells.

some basic predefined methods were lacking proper documentation.
RXY8 methods were added, which add a random phase to each XY8 block,
thus increasing pulse error resistance
@prithviulm prithviulm assigned prithviulm and DerGrace and unassigned DerGrace and prithviulm Dec 2, 2024
@prithviulm prithviulm requested review from DerGrace and prithviulm and removed request for DerGrace December 2, 2024 10:56
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