Skip to content

Commit

Permalink
Update _create_register_funcs docstrings following Giorgio's feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
luisfpereira committed Dec 17, 2024
1 parent f354edb commit b61af64
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion geomfum/_registry.py
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,15 @@ class HierarchicalMeshRegistry(WhichRegistry):


def _create_register_funcs(module):
# create `register_` functions automatically
"""Create ``register`` functions for each class registry in this module.
Given a ``Registry`` (e.g. ``LaplacianFinderRegistry``),
it creates a function ``register_`` by removing ``Registry``
from the name and transforming it in snake case
(e.g. ``register_laplacian_finder``).
These functions are widely used within ``geomstats.wrap``.
"""
for name, method in inspect.getmembers(module):
if not (
hasattr(method, "__bases__")
Expand Down

0 comments on commit b61af64

Please sign in to comment.