Docstrings Missing

[devendragovil]

What

While fixing docstrings, I thought I was not the right person for a few docstrings, so I have added a comment making numpy-doc to skip validation of those functions. This was done so the CI/CD workflow can pass and hence we can move to our usual workflow where PRs are merged only when all GH Actions pass.

How to Detect

There are a total of 5 functions where I have left comments:

# numpydoc ignore=GL08

To Do

These 5 functions need to be resolved.

• transform.graph_to_simplicial_complex.weighted_graph_to_vietoris_rips_complex.is_in_vr_complex
• datasets.graph.karate_club
• datasets.graph.karate_club (another function that is overloaded)
• datasets.mesh.stanford_bunny
• datasets.mesh.stanford_bunny (another function that is overloaded)

[ffl096]

Apart from weighted_graph_to_vietoris_rips_complex.is_in_vr_complex, these are overloaded functions that are documented in the "actual" implementation. They do not require a dedicated documentation, as there are only used for type inference.

weighted_graph_to_vietoris_rips_complex.is_in_vr_complex is a little helper function that is not available outside of the scope of weighted_graph_to_vietoris_rips_complex. I don't think we need to document this function either.