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 doctrings for generic_graph_view #6697

Merged
merged 8 commits into from May 23, 2023
Merged

Added doctrings for generic_graph_view #6697

merged 8 commits into from May 23, 2023

Conversation

salym
Copy link
Contributor

@salym salym commented May 21, 2023

Added the docstring although the function is mainly used by the base classes.

salym added 3 commits May 21, 2023 15:03
Added the docstring although the function is mainly used by the base classes.
just removed a whitespace that caused a style checking error.
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.

Nice -- we should have put docs in here a long time ago. :}

I've just got a couple of suggestions -- please push back if you prefer something else.

Thanks!!

networkx/classes/graphviews.py Outdated Show resolved Hide resolved
networkx/classes/graphviews.py Outdated Show resolved Hide resolved
networkx/classes/graphviews.py Show resolved Hide resolved
salym and others added 2 commits May 21, 2023 18:34
Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Dan Schult <dschult@colgate.edu>
@salym salym closed this May 21, 2023
@salym salym reopened this May 21, 2023
@salym salym requested a review from dschult May 23, 2023 11:59
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.

This looks good to me.
I'll ask you to wrap the text in the doc_string so it is less than 88 chars on a line. (less is even better like <80 but the allow code to reach 88 chars so doc_strings can do that too.)
But this is a very minor thing so will approve it even without that.

networkx/classes/graphviews.py Outdated Show resolved Hide resolved
Co-authored-by: Dan Schult <dschult@colgate.edu>
@MridulS MridulS merged commit 092811c into networkx:main May 23, 2023
34 checks passed
@MridulS
Copy link
Member

MridulS commented May 23, 2023

Thanks @salym! I committed the changes proposed by @dschult :)

@salym
Copy link
Contributor Author

salym commented May 23, 2023

Thanks! I will respect the 80 cols next time.

@jarrodmillman jarrodmillman added this to the 3.2 milestone Jun 4, 2023
Alex-Markham pushed a commit to Alex-Markham/networkx that referenced this pull request Oct 13, 2023
* Added doctrings for generic_graph_view

Added the docstring although the function is mainly used by the base classes.

* Revert "Added doctrings for generic_graph_view"

This reverts commit 9b7f1ad.

* Fixed lint issue

just removed a whitespace that caused a style checking error.

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Added more examples

* Reformulation

* Update networkx/classes/graphviews.py

Co-authored-by: Dan Schult <dschult@colgate.edu>

---------

Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Mridul Seth <mail@mriduls.com>
dschult added a commit to BrunoBaldissera/networkx that referenced this pull request Oct 23, 2023
* Added doctrings for generic_graph_view

Added the docstring although the function is mainly used by the base classes.

* Revert "Added doctrings for generic_graph_view"

This reverts commit 9b7f1ad.

* Fixed lint issue

just removed a whitespace that caused a style checking error.

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Added more examples

* Reformulation

* Update networkx/classes/graphviews.py

Co-authored-by: Dan Schult <dschult@colgate.edu>

---------

Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Mridul Seth <mail@mriduls.com>
cvanelteren pushed a commit to cvanelteren/networkx that referenced this pull request Apr 22, 2024
* Added doctrings for generic_graph_view

Added the docstring although the function is mainly used by the base classes.

* Revert "Added doctrings for generic_graph_view"

This reverts commit 9b7f1ad.

* Fixed lint issue

just removed a whitespace that caused a style checking error.

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Reformulation

Co-authored-by: Dan Schult <dschult@colgate.edu>

* Added more examples

* Reformulation

* Update networkx/classes/graphviews.py

Co-authored-by: Dan Schult <dschult@colgate.edu>

---------

Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Mridul Seth <mail@mriduls.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants