subhypergraph is poorly documented

[leotrs]

It is curently used in one tutorial but not terribly well covered.

This raises a more general issue of discoverability: how do we make sure that users are aware of all functionality at their disposal?

[maximelucas]

This raises a more general issue of discoverability: how do we make sure that users are aware of all functionality at their disposal?

Great point. I think currently a lot of it is not (discoverable), e.g. the stats thing, but not only.

I think having a logical subpackage structure is an important part of this. Right now, the function.py is in the subpackage classes. But I would not go to classes to look for most of what it contains. So we can probably improve on that aspect.

[leotrs]

Yeah function should not be inside classes.

Another idea is to have a place with examples/gallery/formulas/recipes that succinctly show what xgi is capable of and showcase different functionalities in context.

[maximelucas]

I think this can be closed:

• subhypergraph is better documented
• function module has been reorganised Refactor core data structures #412
• more tutos and cookbooks are on their way tutorials - new structure suggestion #414 Cookbook - list suggestion #428 User guides - suggestions for explanation pages #429