Skip to content

Commit

Permalink
Update numpydoc syntax
Browse files Browse the repository at this point in the history
and wrap at 79 characters.
  • Loading branch information
timj committed Jun 5, 2018
1 parent 557b77e commit 9c5c885
Show file tree
Hide file tree
Showing 4 changed files with 207 additions and 93 deletions.
20 changes: 14 additions & 6 deletions python/lsst/utils/get_caller_name.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,28 @@


def get_caller_name(skip=2):
"""Get the name of the caller as a string in the form module.class.method
"""Get the name of the caller method.
Any item that cannot be determined (or is not relevant, e.g. a free function
function has no class) is silently omitted, along with an associated separator.
An empty string is returned if `skip` exceeds the stack height.
Any item that cannot be determined (or is not relevant, e.g. a free
function has no class) is silently omitted, along with an
associated separator.
Parameters
----------
skip : int
skip : `int`
How many levels of stack to skip while getting caller name;
1 means "who calls me", 2 means "who calls my caller", etc.
Returns
-------
name : `str`
Name of the caller as a string in the form ``module.class.method``.
An empty string is returned if ``skip`` exceeds the stack height.
Notes
-----
Adapted from from http://stackoverflow.com/a/9812105
by adding support to get the class from parentframe.f_locals['cls']
by adding support to get the class from ``parentframe.f_locals['cls']``
"""
stack = inspect.stack()
start = 0 + skip
Expand Down

0 comments on commit 9c5c885

Please sign in to comment.