Add a section to Python docs about page for rustworkx-core #944
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
added
documentation
stable-backport-potential
Pull Request Test Coverage Report for Build 5671580120
💛 - Coveralls |
enavarro51
requested changes
Jul 26, 2023
Co-authored-by: Edwin Navarro <enavarro@comcast.net>
enavarro51
approved these changes
Jul 26, 2023
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>
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.