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

move dispatching into function to fix docstrings #4260

Merged
merged 3 commits into from
Jun 16, 2023
Merged

move dispatching into function to fix docstrings #4260

merged 3 commits into from
Jun 16, 2023

Conversation

lillian542
Copy link
Contributor

@lillian542 lillian542 commented Jun 16, 2023 •
edited
Loading

Context:
The call signature in docs for jordan_wigner is ugly due to singledispatch

Description of the Change:
Nest the dispatching inside the function so that sphinx doesn't make the call signature at the top ugly

@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.

@lillian542 lillian542 marked this pull request as ready for review June 16, 2023 15:00
@lillian542 lillian542 added this to the v0.31 milestone Jun 16, 2023
soranjh
soranjh approved these changes Jun 16, 2023
View reviewed changes
Copy link
Contributor

@soranjh soranjh left a comment

Choose a reason for hiding this comment

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

Thanks @lillian542, the docs look good now.

@soranjh soranjh requested review from obliviateandsurrender and removed request for Jaybsoni June 16, 2023 16:39
obliviateandsurrender
obliviateandsurrender approved these changes Jun 16, 2023
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 @lillian542! Looking good.

@lillian542 lillian542 enabled auto-merge (squash) June 16, 2023 16:55
@soranjh soranjh removed the request for review from Jaybsoni June 16, 2023 16:56
@codecov
Copy link

codecov bot commented Jun 16, 2023 •
edited
Loading

Codecov Report

Merging #4260 (2050de2) into master (81b1c65) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #4260   +/-   ##
=======================================
  Coverage   99.79%   99.79%           
=======================================
  Files         352      352           
  Lines       31956    31958    +2     
=======================================
+ Hits        31889    31891    +2     
  Misses         67       67
Impacted Files Coverage Δ
pennylane/fermi/conversion.py 100.00% <100.00%> (ø)
pennylane/qchem/observable_hf.py 100.00% <100.00%> (ø)

@lillian542 lillian542 merged commit ed8ada7 into master Jun 16, 2023
@lillian542 lillian542 deleted the jw-docstring-fix branch June 16, 2023 17:56
frederikwilde pushed a commit that referenced this pull request Jul 5, 2023
@lillian542 @soranjh @frederikwilde
move dispatching into function to fix docstrings (#4260)
86ab67e 
Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@obliviateandsurrender obliviateandsurrender obliviateandsurrender approved these changes

@soranjh soranjh soranjh approved these changes

@timmysilv timmysilv Awaiting requested review from timmysilv

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v0.31
Development

Successfully merging this pull request may close these issues.
3 participants
@lillian542 @obliviateandsurrender @soranjh