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.

Sign up for GitHub

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

Jump to bottom

Update spin docs #6387

Merged
merged 28 commits into from
Oct 24, 2024
Merged

Update spin docs #6387

merged 28 commits into from
Oct 24, 2024

Conversation

soranjh
Copy link
Contributor

@soranjh soranjh commented Oct 11, 2024

Context:
This PR updates the spin function docs for uniformity and consistency. [sc-75955]

@github-actions GitHub Actions
Copy link
Contributor

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.

@codecov Codecov
Copy link

codecov bot commented Oct 11, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.38%. Comparing base (50049a9) to head (0f47abd).
Report is 2 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #6387      +/-   ##
==========================================
- Coverage   99.38%   99.38%   -0.01%     
==========================================
  Files         448      448              
  Lines       42578    42564      -14     
==========================================
- Hits        42318    42304      -14     
  Misses        260      260

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

ddhawan11
ddhawan11 reviewed Oct 14, 2024
View reviewed changes
Copy link
Contributor

@ddhawan11 ddhawan11 left a comment

Choose a reason for hiding this comment

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

Thanks @soranjh. I only have a couple of minor comments.

pennylane/spin/spin_hamiltonian.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Show resolved Hide resolved
obliviateandsurrender
obliviateandsurrender reviewed Oct 18, 2024
View reviewed changes
Copy link
Contributor

@obliviateandsurrender obliviateandsurrender left a comment

Choose a reason for hiding this comment

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

Thanks @soranjh! Looks great, leaving some minor suggestions.

pennylane/spin/lattice.py Outdated Show resolved Hide resolved
pennylane/spin/lattice.py Outdated Show resolved Hide resolved
pennylane/spin/lattice.py Show resolved Hide resolved
pennylane/spin/lattice.py Show resolved Hide resolved
pennylane/spin/lattice.py Outdated Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Show resolved Hide resolved
pennylane/spin/spin_hamiltonian.py Show resolved Hide resolved
doc/code/qml_spin.rst Show resolved Hide resolved
soranjh
soranjh commented Oct 21, 2024
View reviewed changes
pennylane/spin/__init__.py Outdated Show resolved Hide resolved
ddhawan11
ddhawan11 approved these changes Oct 22, 2024
View reviewed changes
Copy link
Contributor

@ddhawan11 ddhawan11 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 @soranjh

isaacdevlugt
isaacdevlugt approved these changes Oct 22, 2024
View reviewed changes
doc/code/qml_spin.rst Show resolved Hide resolved
obliviateandsurrender
obliviateandsurrender approved these changes Oct 23, 2024
View reviewed changes
Copy link
Contributor

@obliviateandsurrender obliviateandsurrender left a comment

Choose a reason for hiding this comment

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

Just a couple of final non-blocking comments. Don't forget to add the changelog.

pennylane/spin/lattice.py Outdated Show resolved Hide resolved
pennylane/spin/lattice.py Outdated Show resolved Hide resolved
@soranjh soranjh enabled auto-merge (squash) October 24, 2024 13:09
@soranjh soranjh merged commit c0ff54c into master Oct 24, 2024
39 checks passed
@soranjh soranjh deleted the spin_docs branch October 24, 2024 17:53
mudit2812 pushed a commit that referenced this pull request Nov 11, 2024
@soranjh @mudit2812
Update spin docs (#6387)
bed0d43 
**Context:**
This PR updates the spin function docs for uniformity and consistency.
[sc-75955]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@isaacdevlugt isaacdevlugt isaacdevlugt approved these changes

@ddhawan11 ddhawan11 ddhawan11 approved these changes

@obliviateandsurrender obliviateandsurrender obliviateandsurrender approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@soranjh @obliviateandsurrender @isaacdevlugt @ddhawan11