Skip to content

Commit ef0b977

Browse files
committed
DOC: Make a TODO item more prominent
1 parent 0d1e022 commit ef0b977

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pdoc/__init__.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1081,6 +1081,11 @@ def params(self, *, annotate: bool = False, link: Callable[[Doc], str] = None) -
10811081
If `annotate` is True, the parameter strings include [PEP 484]
10821082
type hint annotations.
10831083
1084+
.. todo::
1085+
Extract signature from the first lines of currently-unsupported builtin
1086+
functions' (such as `itertools.count()` or `numpy.array()`) docstrings.
1087+
See _TODO_ marker in the code for ideas.
1088+
10841089
[PEP 484]: https://www.python.org/dev/peps/pep-0484/
10851090
"""
10861091
return self._params(self.obj, annotate=annotate, link=link, module=self.module)
@@ -1091,6 +1096,8 @@ def _params(func_obj, annotate=False, link=None, module=None):
10911096
signature = inspect.signature(inspect.unwrap(func_obj))
10921097
except ValueError:
10931098
# I guess this is for C builtin functions?
1099+
# TODO: Extract signature from the first line of the docstring, i.e.
1100+
# https://github.com/mitmproxy/pdoc/commit/010d996003bc5b72fcf5fa515edbcc0142819919
10941101
return ["..."]
10951102

10961103
def safe_default_value(p: inspect.Parameter):

0 commit comments

Comments
 (0)