AnswerDotAI / AnswerDotAI/fastcore

show_doc does not display return value docment for function/method with no arguments

Open
#503 0 comments 0 reactions 0 assignees View on GitHub
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)
```
Screen Shot 2022-12-13 at 2 02 48 AM

I would expect there to be a table entry with "Integral result of addition operator".

Contributor guide

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.