MCPcopy Create free account
hub / github.com/numpy/numpy / getdoc

Method getdoc

numpy/ma/core.py:8394–8404  ·  view source on GitHub ↗

Return the doc of the function (from the doc of the method).

(self, np_ret, np_ma_ret)

Source from the content-addressed store, hash-verified

8392 self._extras = params or {}
8393
8394 def getdoc(self, np_ret, np_ma_ret):
8395 "Return the doc of the function (from the doc of the method)."
8396 doc = getattr(self._func, '__doc__', None)
8397 sig = get_object_signature(self._func)
8398 if doc:
8399 doc = self._replace_return_type(doc, np_ret, np_ma_ret)
8400 # Add the signature of the function at the beginning of the doc
8401 if sig:
8402 sig = "%s%s\n" % (self._func.__name__, sig)
8403 doc = sig + doc
8404 return doc
8405
8406 def _replace_return_type(self, doc, np_ret, np_ma_ret):
8407 """

Callers 1

__init__Method · 0.95

Calls 2

_replace_return_typeMethod · 0.95
get_object_signatureFunction · 0.85

Tested by

no test coverage detected