Update LCF_graph docstring
#7262
Conversation
Use numpydoc docstring standard and fixup formatting/examples.
rossbar
force-pushed
the
doc/fix-lcf-notation-docstring
branch
from
97ed184
to
e2e551b
Compare
networkx/generators/small.py
Outdated
| For each node ``n_i``, cycling through the n-cycle a total of ``len(shift_list) * repeats`` | ||
| with shift cycling through `shift_list` `repeat` s times connects ``n_i`` | ||
| with ``n_i + shift mod n``. |
There was a problem hiding this comment.
This sentence is not clear to me -- though some of that may be because words and notation are defined in the parameters section below. Is there a way to describe what this will say before saying it? Or maybe turning the sentence around with "Each node n_i connects with n_i + shift mod n where shift is cycling through input shift_list ... "...
It would probably also help to say that all the nodes are the first N integers, with connections determined by relationships mod N. But I don't understand enough to describe that relationship yet. I understand much better than before though. :)
There was a problem hiding this comment.
I'm in the same boat - this was my feeble attempt at mashing together the existing description with what I could understand from reading the code. Let me take another stab incorporating these suggestions!
There was a problem hiding this comment.
I took your advice of flipping the sentence around which I agree improves the clarity. Whether or not it improves the situation enough is another question --- LMK what you think!
* Update lcf_graph docstring. Use numpydoc docstring standard and fixup formatting/examples. * Reword incorporating review suggestions.
Use numpydoc docstring standard and fixup formatting/examples.