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

Add a section to Python docs about page for rustworkx-core #944

Merged
merged 2 commits into from
Jul 26, 2023

Conversation

mtreinish
Copy link
Member

The main page explaining the rustworkx library in the Python docs previously didn't make any mention of rustworkx-core. While in general the Python side is built on top of rustworkx-core and the vast majority of the users of the Python library don't need to know about the pure Rust library inside, it is still good to highlight its existence in case anyone finds the Python library but is really interested in consuming it from Rust. This commit just adds a small subsection to the about page explaining the existence of rustworkx-core, its purpose, and where you can find mroe information about it.

The main page explaining the rustworkx library in the Python docs
previously didn't make any mention of rustworkx-core. While in general
the Python side is built on top of rustworkx-core and the vast majority
of the users of the Python library don't need to know about the pure
Rust library inside, it is still good to highlight its existence in case
anyone finds the Python library but is really interested in consuming it
from Rust. This commit just adds a small subsection to the about page
explaining the existence of rustworkx-core, its purpose, and where you
can find mroe information about it.
@mtreinish mtreinish added documentation stable-backport-potential This PR or issue is potentially worth backporting for inclusion in a stable branch labels Jul 26, 2023
@mtreinish mtreinish added this to the 0.13.1 milestone Jul 26, 2023
@coveralls
Copy link

coveralls commented Jul 26, 2023

Pull Request Test Coverage Report for Build 5671580120

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 96.423%

Totals Coverage Status
Change from base Build 5650584221: 0.0%
Covered Lines: 15283
Relevant Lines: 15850

💛 - Coveralls

Copy link
Contributor

@enavarro51 enavarro51 left a comment

Choose a reason for hiding this comment

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

This is a good addition as we put more and more into core. LGTM, with just a couple of readability comments.

docs/source/index.rst Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved
Co-authored-by: Edwin Navarro <enavarro@comcast.net>
@mtreinish mtreinish added the automerge Queue a approved PR for merging label Jul 26, 2023
@mergify mergify bot merged commit 2a16d21 into Qiskit:main Jul 26, 2023
26 checks passed
mergify bot pushed a commit that referenced this pull request Jul 26, 2023
* Add a section to Python docs about page for rustworkx-core

The main page explaining the rustworkx library in the Python docs
previously didn't make any mention of rustworkx-core. While in general
the Python side is built on top of rustworkx-core and the vast majority
of the users of the Python library don't need to know about the pure
Rust library inside, it is still good to highlight its existence in case
anyone finds the Python library but is really interested in consuming it
from Rust. This commit just adds a small subsection to the about page
explaining the existence of rustworkx-core, its purpose, and where you
can find mroe information about it.

* Apply suggestions from code review

Co-authored-by: Edwin Navarro <enavarro@comcast.net>

---------

Co-authored-by: Edwin Navarro <enavarro@comcast.net>
(cherry picked from commit 2a16d21)
mergify bot added a commit that referenced this pull request Jul 26, 2023
* Add a section to Python docs about page for rustworkx-core

The main page explaining the rustworkx library in the Python docs
previously didn't make any mention of rustworkx-core. While in general
the Python side is built on top of rustworkx-core and the vast majority
of the users of the Python library don't need to know about the pure
Rust library inside, it is still good to highlight its existence in case
anyone finds the Python library but is really interested in consuming it
from Rust. This commit just adds a small subsection to the about page
explaining the existence of rustworkx-core, its purpose, and where you
can find mroe information about it.

* Apply suggestions from code review

Co-authored-by: Edwin Navarro <enavarro@comcast.net>

---------

Co-authored-by: Edwin Navarro <enavarro@comcast.net>
(cherry picked from commit 2a16d21)

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
@mtreinish mtreinish deleted the core-in-main-docs branch July 29, 2023 20:22
raynelfss pushed a commit to raynelfss/rustworkx that referenced this pull request Aug 10, 2023
* Add a section to Python docs about page for rustworkx-core

The main page explaining the rustworkx library in the Python docs
previously didn't make any mention of rustworkx-core. While in general
the Python side is built on top of rustworkx-core and the vast majority
of the users of the Python library don't need to know about the pure
Rust library inside, it is still good to highlight its existence in case
anyone finds the Python library but is really interested in consuming it
from Rust. This commit just adds a small subsection to the about page
explaining the existence of rustworkx-core, its purpose, and where you
can find mroe information about it.

* Apply suggestions from code review

Co-authored-by: Edwin Navarro <enavarro@comcast.net>

---------

Co-authored-by: Edwin Navarro <enavarro@comcast.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Queue a approved PR for merging documentation stable-backport-potential This PR or issue is potentially worth backporting for inclusion in a stable branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants