Skip to content

Update general_k_edge_subgraphs docstring.#7254

Merged
dschult merged 1 commit intonetworkx:mainfrom
rossbar:doc/k-edge-subraphs
Jan 30, 2024
Merged

Update general_k_edge_subgraphs docstring.#7254
dschult merged 1 commit intonetworkx:mainfrom
rossbar:doc/k-edge-subraphs

Conversation

@rossbar
Copy link
Contributor

@rossbar rossbar commented Jan 29, 2024

Minor updates to docstring:

  • Adds a parameters section
  • Returns -> Yields and update wording to clarify that graphs are yielded, not node sets
  • Fix format of links to references
  • Update example to use comprehension instead of map

Closes #7253

dschult
dschult approved these changes Jan 30, 2024
View reviewed changes
Copy link
Member

@dschult dschult left a comment

Choose a reason for hiding this comment

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

LGTM :}

@dschult dschult merged commit 30ac795 into networkx:main Jan 30, 2024
@jarrodmillman jarrodmillman added this to the 3.3 milestone Jan 30, 2024
cvanelteren pushed a commit to cvanelteren/networkx that referenced this pull request Apr 22, 2024
@rossbar @cvanelteren
Update general_k_edge_subgraphs docstring. (networkx#7254)
ba4e559
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dschult dschult dschult approved these changes

Assignees

No one assigned

Labels

type: Documentation

Milestone

3.3

Development

Successfully merging this pull request may close these issues.

Return type of general_k_edge_subgraphs is incorrect in docstring

3 participants

@rossbar @dschult @jarrodmillman