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

minor addition to edges docstring #417

Merged
merged 1 commit into from
Feb 20, 2025
Merged

Conversation

Krastanov
Copy link
Member

Seeing that edges is lexicographical took me a minute longer than necessary, so I thought this small addition is warranted.

Copy link

codecov bot commented Feb 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.30%. Comparing base (a6571dd) to head (03fee66).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #417   +/-   ##
=======================================
  Coverage   97.30%   97.30%           
=======================================
  Files         117      117           
  Lines        6948     6948           
=======================================
  Hits         6761     6761           
  Misses        187      187           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@simonschoelly
Copy link
Member

I am not sure that we currently guarantee this for any AbstractSimpleGraph. Having this as part of the abstract interface might make some implementations slow as they will have to sort the edges first.

Perhaps we should only guarantee this for SimpleGraph and SimpleDiGraph? Or is it important that this is also the case for other graphs in your case?

@Krastanov
Copy link
Member Author

It is guaranteed in another part of the documentation. This PR is meant to simply make that guarantee easier to find for the reader.
image

@Krastanov
Copy link
Member Author

but to answer your question, no the general case is not important for me

@simonschoelly
Copy link
Member

In that case it makes sense. Thanks.

@simonschoelly simonschoelly merged commit 12ac6ba into master Feb 20, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants