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

Documentation missing for watts_strogatz_hypergraph #615

Closed
tlarock opened this issue Oct 29, 2024 · 1 comment · Fixed by #618
Closed

Documentation missing for watts_strogatz_hypergraph #615

tlarock opened this issue Oct 29, 2024 · 1 comment · Fixed by #618
Labels
documentation Improvements or additions to documentation

Comments

@tlarock
Copy link
Collaborator

tlarock commented Oct 29, 2024

I was looking at the generators module and noticed that there is no documentation for watts_strogatz_hypergraph. While reading the source is enough to broadly understand the generation process, I am not familiar with the origins of this model, so it would be helpful to add a description and reference. It may also be useful to give the parameters more meaningful names (or just explain that they are inputs to ring_lattice, plus a rewire probability).

@tlarock tlarock added the documentation Improvements or additions to documentation label Oct 29, 2024
@nwlandry
Copy link
Collaborator

nwlandry commented Nov 7, 2024

Thanks for bringing this up, @tlarock! I believe that @leotrs wrote this function. Leo, do you have a reference for this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants