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

Bug fix/documentation #223

Merged
merged 15 commits into from
Sep 20, 2022
Merged

Conversation

jackraymond
Copy link
Contributor

Tidied up inaccuracies in docstrings for edge_list and node_list in graph generators.
Added option for strict topological compliance of edge_list and node_list in these same generators, defaulted to legacy behaviour.
Resolves this bug: #222

@codecov-commenter
Copy link

codecov-commenter commented Jul 15, 2022

Codecov Report

Merging #223 (b13a571) into main (4bc8242) will increase coverage by 0.30%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #223      +/-   ##
==========================================
+ Coverage   74.88%   75.18%   +0.30%     
==========================================
  Files          30       31       +1     
  Lines        2086     2112      +26     
==========================================
+ Hits         1562     1588      +26     
  Misses        524      524              
Impacted Files Coverage Δ
dwave_networkx/algorithms/elimination_ordering.py 85.57% <ø> (ø)
dwave_networkx/generators/chimera.py 86.69% <100.00%> (+0.40%) ⬆️
dwave_networkx/generators/common.py 100.00% <100.00%> (ø)
dwave_networkx/generators/pegasus.py 89.61% <100.00%> (+0.16%) ⬆️
dwave_networkx/generators/zephyr.py 97.04% <100.00%> (+0.09%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@arcondello arcondello requested a review from boothby July 18, 2022 16:03
Copy link
Contributor

@boothby boothby left a comment

Choose a reason for hiding this comment

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

Looks good modulo suggested change.

dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/pegasus.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/pegasus.py Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
Copy link
Contributor

@JoelPasvolsky JoelPasvolsky left a comment

Choose a reason for hiding this comment

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

Just FYI :code:something is equivalent to double backquotes

dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/chimera.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
dwave_networkx/generators/zephyr.py Outdated Show resolved Hide resolved
jackraymond and others added 10 commits August 10, 2022 13:49
Grammar

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Grammar

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Missing argument formatting

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
inappropriate abbreviation in docstring

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Missing markup in docstrings

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Typo in docstring

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Typo in docstrings

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Typos and markup omissions

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Markup and grammar

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
Markup and grammar

Co-authored-by: Joel <34041130+JoelPasvolsky@users.noreply.github.com>
@randomir randomir merged commit b0dee61 into dwavesystems:main Sep 20, 2022
@jackraymond jackraymond deleted the bug-fix/documentation branch November 29, 2022 18:06
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.

5 participants