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
Conversation
Added the docstring although the function is mainly used by the base classes.
This reverts commit 9b7f1ad.
just removed a whitespace that caused a style checking error.
There was a problem hiding this 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!!
Co-authored-by: Dan Schult <dschult@colgate.edu>
Co-authored-by: Dan Schult <dschult@colgate.edu>
There was a problem hiding this 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.
Co-authored-by: Dan Schult <dschult@colgate.edu>
Thanks! I will respect the 80 cols next time. |
* 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>
* 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>
* 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>
Added the docstring although the function is mainly used by the base classes.