Skip to content

Commit

Permalink
docs: add example function needed for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
schmidni committed May 22, 2024
1 parent 647eb97 commit 6a30ddf
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions seismostats/utils/docs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
def _example():
"""
This function is purely used as an example for the documentation.
See Also:
:func:`seismostats.Catalog.bin_magnitudes`
"""
pass

0 comments on commit 6a30ddf

Please sign in to comment.