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

[v0.40.0 QA] PL Docs Improvements #6774

Merged
merged 8 commits into from
Jan 9, 2025

Conversation

andrijapau
Copy link
Contributor

@andrijapau andrijapau commented Jan 7, 2025

Context:

Pure documentation improvements found during the v0.40 quality assurance process.

Source-code improvements are addressed in #6773.

Copy link
Contributor

github-actions bot commented Jan 7, 2025

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@andrijapau andrijapau marked this pull request as draft January 7, 2025 16:58
Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (v0.40.0-docs@0ab9d24). Learn more about missing BASE report.

Additional details and impacted files
@@               Coverage Diff               @@
##             v0.40.0-docs    #6774   +/-   ##
===============================================
  Coverage                ?   99.60%           
===============================================
  Files                   ?      476           
  Lines                   ?    45233           
  Branches                ?        0           
===============================================
  Hits                    ?    45056           
  Misses                  ?      177           
  Partials                ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@andrijapau andrijapau changed the title [v0.40.0 QA] Documentation Improvements [v0.40.0 QA] PL Docs Improvements Jan 8, 2025
@andrijapau andrijapau added this to the v0.40 milestone Jan 8, 2025
@lillian542 lillian542 self-requested a review January 8, 2025 20:15
Copy link
Contributor

@lillian542 lillian542 left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@andrijapau andrijapau marked this pull request as ready for review January 9, 2025 14:25
@andrijapau andrijapau merged commit 37f4cd3 into v0.40.0-docs Jan 9, 2025
51 checks passed
@andrijapau andrijapau deleted the v0.40.0-QA-AP-documentation branch January 9, 2025 14:45
andrijapau added a commit that referenced this pull request Jan 9, 2025
**Context:**

Source-code improvements found during the v0.40 quality assurance
process.

Documentation focused improvements are addressed in #6774.

**Description of the Change:**

A few things were adjusted in this PR,

**Bosonic Operators**

- `BoseX` and `FermiX` are now both top-level (as suggested by product).
- `BoseX` now raises a `TypeError` (instead of a `ValueError` for an
inappropriate operator type (was suggested in the original PR but was
never implemented).
- Minor documentation clean-up due to top-level access adjustment.
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