Skip to content

Di graph edges doc fix#6108

Merged
MridulS merged 6 commits intonetworkx:mainfrom
nsengiyumva-wilberforce:di_graph_edges_doc_fix
Nov 14, 2022
Merged

Di graph edges doc fix#6108
MridulS merged 6 commits intonetworkx:mainfrom
nsengiyumva-wilberforce:di_graph_edges_doc_fix

Conversation

@nsengiyumva-wilberforce
Copy link
Copy Markdown
Contributor

@nsengiyumva-wilberforce nsengiyumva-wilberforce commented Oct 20, 2022 •
edited by rossbar
Loading

Improved the docstring description and added examples for how InEdgeView works.
Note: Examples were extracted from discussions that were help in this.

Related to #4765

@MridulS , please review and merge it if possible so that I can complete my application

@rossbar
Copy link
Copy Markdown
Contributor

rossbar commented Oct 21, 2022

Thanks @nsengiyumva-wilberforce - based on the diff, I suspect there are a couple accidental commits to this branch. Did you intend to also add the line tests to this PR? It might be best to split the test updates out to a separate branch to keep the scope of this PR restricted to the documentation fixes.

@nsengiyumva-wilberforce
Copy link
Copy Markdown
Contributor Author

nsengiyumva-wilberforce commented Oct 21, 2022

Thanks @nsengiyumva-wilberforce - based on the diff, I suspect there are a couple accidental commits to this branch. Did you intend to also add the line tests to this PR? It might be best to split the test updates out to a separate branch to keep the scope of this PR restricted to the documentation fixes.

I have removed, I intended them to be part but from your advice, it's better to separate them

@nsengiyumva-wilberforce nsengiyumva-wilberforce mentioned this pull request Oct 21, 2022
Merged
MridulS
MridulS reviewed Oct 21, 2022
View reviewed changes
MridulS
MridulS reviewed Oct 21, 2022
View reviewed changes
@nsengiyumva-wilberforce nsengiyumva-wilberforce mentioned this pull request Oct 26, 2022
Closed
rossbar
rossbar reviewed Oct 28, 2022
View reviewed changes
@nsengiyumva-wilberforce
Copy link
Copy Markdown
Contributor Author

nsengiyumva-wilberforce commented Nov 1, 2022

@rossbar I have addressed your comments here

rossbar
rossbar approved these changes Nov 10, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@rossbar rossbar left a comment

Choose a reason for hiding this comment

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

Thanks @nsengiyumva-wilberforce , this seems on the right track to me. Rather than continuing to iterate via suggestions, I took the liberty of pushing up a few tweaks, including making similar changes to the MultiDiGraph.in_edges docstring.

I'm ambivalent about adding the Examples section as I'm not sure it helps address the original confusion, but that's not a blocker for me.

Thanks for the updates!

@nsengiyumva-wilberforce
Copy link
Copy Markdown
Contributor Author

nsengiyumva-wilberforce commented Nov 10, 2022

Thanks @nsengiyumva-wilberforce , this seems on the right track to me. Rather than continuing to iterate via suggestions, I took the liberty of pushing up a few tweaks, including making similar changes to the MultiDiGraph.in_edges docstring.

I'm ambivalent about adding the Examples section as I'm not sure it helps address the original confusion, but that's not a blocker for me.

Thanks for the updates!

Welcome

@MridulS MridulS merged commit 2244bad into networkx:main Nov 14, 2022
@nsengiyumva-wilberforce nsengiyumva-wilberforce deleted the di_graph_edges_doc_fix branch November 15, 2022 14:43
@jarrodmillman jarrodmillman added this to the networkx-3.0 milestone Jan 6, 2023
MridulS pushed a commit to MridulS/networkx that referenced this pull request Feb 4, 2023
@nsengiyumva-wilberforce @rossbar @MridulS
Di graph edges doc fix (networkx#6108)
ea125cb 
* Improve documentation for the View classes

* space removed

* use G instead of g

* update the line a few above to in_edges : InEdgeView or InEdgeDataView

* Minor tweaks to docstring, update summary.

* Apply similar changes to MultiDiGraph.in_edges docstring.

Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Mjh9122 pushed a commit to Mjh9122/networkx that referenced this pull request Feb 27, 2023
@nsengiyumva-wilberforce @rossbar @Mjh9122
Di graph edges doc fix (networkx#6108)
f9b1cb8 
* Improve documentation for the View classes

* space removed

* use G instead of g

* update the line a few above to in_edges : InEdgeView or InEdgeDataView

* Minor tweaks to docstring, update summary.

* Apply similar changes to MultiDiGraph.in_edges docstring.

Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
cvanelteren pushed a commit to cvanelteren/networkx that referenced this pull request Apr 22, 2024
@nsengiyumva-wilberforce @rossbar @cvanelteren
Di graph edges doc fix (networkx#6108)
20e1ffd 
* Improve documentation for the View classes

* space removed

* use G instead of g

* update the line a few above to in_edges : InEdgeView or InEdgeDataView

* Minor tweaks to docstring, update summary.

* Apply similar changes to MultiDiGraph.in_edges docstring.

Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MridulS MridulS MridulS left review comments

@rossbar rossbar rossbar approved these changes

Assignees

No one assigned

Labels

None yet

Milestone

networkx-3.0

Development

Successfully merging this pull request may close these issues.

4 participants

@nsengiyumva-wilberforce @rossbar @MridulS @jarrodmillman