AnswerDotAI / AnswerDotAI/fastcore
show_doc does not display return value docment for function/method with no arguments
- Dominant language
- Jupyter Notebook
- Stars
- 1.1k
- Forks
- 295
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 7
Description
Example from the documentation:
``` python
class Adder:
"An addition calculator"
def __init__(self,
a:int, # First operand
b:int, # 2nd operand
): self.a,self.b = a,b
def calculate(self
)->int: # Integral result of addition operator
"Add `a` to `b`"
return a+b
show_doc(Adder.calculate)
```

I would expect there to be a table entry with "Integral result of addition operator".
Contributor guide
Research direction
Reproduce the documented Adder example and call show_doc(Adder.calculate) to confirm that the return annotation is missing. Start by tracing the show_doc entry point and its handling of methods with no arguments; done means the output includes "Integral result of addition operator" in the return-value table.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100