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

Added empty and complete graph generators #679

Merged
merged 6 commits into from
Oct 11, 2022

Conversation

prakharb10
Copy link
Contributor

Added generators for empty and complete graphs.

Partially addresses #150.

@coveralls
Copy link

coveralls commented Sep 15, 2022

Pull Request Test Coverage Report for Build 3230698228

  • 54 of 54 (100.0%) changed or added relevant lines in 1 file are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.01%) to 97.048%

Files with Coverage Reduction New Missed Lines %
src/generators.rs 1 97.47%
Totals Coverage Status
Change from base Build 3221646801: 0.01%
Covered Lines: 13314
Relevant Lines: 13719

💛 - Coveralls

src/generators.rs Outdated Show resolved Hide resolved
@prakharb10
Copy link
Contributor Author

Does this PR also require a reno? If yes, could you tell me what sections need to be included?

@mtreinish
Copy link
Member

Yes I think a reno release note would be appropriate here, I would say add two notes as features, one documenting the addition of the empty graph functions and the second documenting adding the complete graph functions

Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

Overall this LGTM, thanks for the update. I have just one small suggestion inline on the release note for complete_graph we should refer to it being the same as mesh_graph to document it's just an alias. But other than that I think this is ready to merge

Comment on lines 18 to 21
Added new generator functions, :func:`~rustworkx.generators.complete_graph`,
and :func:`~rustworkx.generators.directed_complete_graph` to the
``rustworkx.generators`` module that will generate a complete graph.
For example:
Copy link
Member

@mtreinish mtreinish Oct 3, 2022

Choose a reason for hiding this comment

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

I would add something here about this being identical to mesh_graph() but using a more standard name for the functionality.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the reno @mtreinish. Let me know if further changes are required

@mtreinish mtreinish added the automerge Queue a approved PR for merging label Oct 11, 2022
@mergify mergify bot merged commit c817aa1 into Qiskit:main Oct 11, 2022
@prakharb10 prakharb10 deleted the empty_complete branch October 12, 2022 01:29
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants