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

Improve docs #1175

Merged
merged 4 commits into from
May 23, 2023
Merged

Improve docs #1175

merged 4 commits into from
May 23, 2023

Conversation

woodsp-ibm
Copy link
Member

@woodsp-ibm woodsp-ibm commented May 22, 2023

Summary

Similar to qiskit-community/qiskit-machine-learning#635
Resolves #1055

This changes things here, which used to have a couple of templates where inherited methods was the choice and no inheritence the default, over to inherited methods are shown by default and it has to be selected to suppress them - which presently is just done for circuit library classes inheriting from QuantumCircuit. This is also how Qiskit does things.

It fails locally with make spell for me, as I imagine it pulls stuff in that was not before. But I will let it go through CI here once before changing anything in that regard assuming it fails likewise here.

Locally I had deleted the with_inherited rst template and added a the no_inherited one - but it ended up as a rename and change of contents which is fine.

Details and comments

@woodsp-ibm woodsp-ibm added type: documentation Issues related to documentation stable backport potential The bug might be minimal and/or import enough to be port to stable labels May 22, 2023
@coveralls
Copy link

coveralls commented May 22, 2023

Pull Request Test Coverage Report for Build 5054363760

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.009%) to 87.471%

Files with Coverage Reduction New Missed Lines %
qiskit_nature/second_q/drivers/psi4d/psi4driver.py 1 84.75%
Totals Coverage Status
Change from base Build 5054346042: 0.009%
Covered Lines: 9404
Relevant Lines: 10751

💛 - Coveralls

@woodsp-ibm woodsp-ibm changed the title [WIP] Improve docs Improve docs May 22, 2023
@woodsp-ibm
Copy link
Member Author

FYI. This has an interplay with #1085 where this part in the init file, the :template:... line below would be removed, as showing inherited members is now the default.

BosonicOp Mappers
+++++++++++++++++++

.. autosummary::
   :toctree: ../stubs/
   :template: autosummary/class_with_inherited_members.rst
   :nosignatures:
   
   BosonicLinearMapper

Copy link
Member

@mrossinek mrossinek left a comment

Choose a reason for hiding this comment

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

Thanks a lot, Steve!

I resolved the interplay after #1085 got merged.

In hindsight, maybe merging in the other order would have been preferable as now this backport will have a minor conflict, but its too late for that now 😅

@mergify mergify bot merged commit 1eec83b into qiskit-community:main May 23, 2023
mergify bot pushed a commit that referenced this pull request May 23, 2023
* Update mergify config

* Fix copyright

* Update after merging the bosonic operator PR

---------

Co-authored-by: Max Rossmannek <[email protected]>
(cherry picked from commit 1eec83b)

# Conflicts:
#	qiskit_nature/second_q/mappers/__init__.py
@mergify mergify bot mentioned this pull request May 23, 2023
mergify bot added a commit that referenced this pull request May 23, 2023
* Improve docs (#1175)

* Update mergify config

* Fix copyright

* Update after merging the bosonic operator PR

---------

Co-authored-by: Max Rossmannek <[email protected]>
(cherry picked from commit 1eec83b)

# Conflicts:
#	qiskit_nature/second_q/mappers/__init__.py

* Resolve merge conflicts

---------

Co-authored-by: Steve Wood <[email protected]>
Co-authored-by: Max Rossmannek <[email protected]>
@woodsp-ibm woodsp-ibm deleted the docs_inherit branch May 23, 2023 11:50
Anthony-Gandon pushed a commit to Anthony-Gandon/qiskit-nature that referenced this pull request May 25, 2023
* Update mergify config

* Fix copyright

* Update after merging the bosonic operator PR

---------

Co-authored-by: Max Rossmannek <[email protected]>
@mrossinek mrossinek mentioned this pull request Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge stable backport potential The bug might be minimal and/or import enough to be port to stable type: documentation Issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document inherited members by default
3 participants