AnswerDotAI / AnswerDotAI/nbdev
Render docs for methods by default
Open
enhancement
- Dominant language
- Jupyter Notebook
- Stars
- 5.3k
- Forks
- 513
- Avg merge
- 2d 30m
- Merged PRs (30d)
- 8
Description
We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?
Contributor guide
Research direction
No file, test, or entry point is named. Start by locating the implementation and tests for showdoc(method), then compare default rendering with explicit showdoc(...). Done means method documentation renders without requiring showdoc(...) while the existing explicit usage remains supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100