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

📝 Fix a few oversights in the RTD documentation of SiDB simulation functionality #513

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

marcelwa
Copy link
Collaborator

@marcelwa marcelwa commented Aug 28, 2024

Description

operational_domain_value_range was missing from the C++ part of the RTD documentation. Additionally, dimer_displacement_policy was redundant in the C++ documentation but missing the Python one. This PR fixes these oversights.

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have added a changelog entry.
  • I have created/adjusted the Python bindings for any new or updated functionality.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

@marcelwa marcelwa added documentation Documentation is added or needed small fix Non-critical issue or inconsistency labels Aug 28, 2024
@marcelwa marcelwa self-assigned this Aug 28, 2024
…mentation and added missing `dimer_displacement_policy` to Python RTD documentation
@marcelwa marcelwa changed the title 📝 Added missing RTD documentation on operational_domain_value_range 📝 Fix a few oversights in the RTD documentation of SiDB simulation functionality Aug 28, 2024
@marcelwa marcelwa merged commit 7a7eb32 into main Aug 28, 2024
2 checks passed
@marcelwa marcelwa deleted the operational-domain-docs-fix branch August 28, 2024 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation is added or needed small fix Non-critical issue or inconsistency
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant