Skip to content

Enhance docs for adj/pred/succ methods in PyDiGraph and add find_successor_node_by_edge method #1401

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
Merged
merged 2 commits into from
Mar 27, 2025
Merged

Enhance docs for adj/pred/succ methods in PyDiGraph and add find_successor_node_by_edge method #1401

merged 2 commits into from
Mar 27, 2025

Conversation

eumiro
Copy link
Contributor

@eumiro eumiro commented Mar 25, 2025

  • add examples to all adj/pred/succ methods in PyDiGraph
  • add method find_successor_edge_by_node that is just just a minimally modified version of find_predecessor_edge_by_node.
  • I ran rustfmt locally
  • I have added the tests to cover my changes.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.

@eumiro eumiro force-pushed the digraph-adj-succ-pred branch from 058a543 to 76d6fde Compare March 25, 2025 18:16
@coveralls
Copy link

coveralls commented Mar 25, 2025 •
edited
Loading

Pull Request Test Coverage Report for Build 14091392590

Details

  • 22 of 22 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 95.339%
Totals Coverage Status
Change from base Build 14073586633: 0.02%
Covered Lines: 18492
Relevant Lines: 19396
💛 - Coveralls

IvanIsCoding
IvanIsCoding reviewed Mar 26, 2025
View reviewed changes
Copy link
Collaborator

@IvanIsCoding IvanIsCoding left a comment

Choose a reason for hiding this comment

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

I will review this later today but I left a comment about hyperlinks

@eumiro eumiro force-pushed the digraph-adj-succ-pred branch from 76d6fde to bff00f6 Compare March 26, 2025 19:01
@IvanIsCoding IvanIsCoding added this pull request to the merge queue Mar 27, 2025
Merged via the queue into Qiskit:main with commit ae695d5 Mar 27, 2025
31 checks passed
@IvanIsCoding
Copy link
Collaborator

Whatever we did here has the right syntax for hyperlinks: https://www.rustworkx.org/dev/apiref/rustworkx.PyDiGraph.find_successor_node_by_edge.html#rustworkx.PyDiGraph.find_successor_node_by_edge has the right links

@eumiro eumiro deleted the digraph-adj-succ-pred branch March 27, 2025 18:25
SILIZ4 pushed a commit to SILIZ4/rustworkx that referenced this pull request Jul 4, 2025
@eumiro @SILIZ4
Enhance docs for adj/pred/succ methods in PyDiGraph and add find_succ…
183f9a3 
…essor_node_by_edge method (Qiskit#1401)

* Add examples to adj/successor/predecessor methods of digraph

* Add find_successor_node_by_edge method
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IvanIsCoding IvanIsCoding IvanIsCoding 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.
3 participants
@eumiro @coveralls @IvanIsCoding