posit-dev / posit-dev/positron
python: Help pane inconsistent for packages generated with `nbdev`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 4.3k
- Forks
- 184
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 206
Description
nbdev is a style of writing packages (including scripts, documentation, etc) inside Jupyter Notebooks. The current way we show documentation in Help does not have a consistently good experience with packages developed via nbdev. A good example of this is ghapi. Some function references render nicely, while others are just a reference to a Jupyter notebook, like below
pip install ghapi
from ghapi.all import GhApi
GhApi.create_branch_empty?
In contrast, GhApi.list_branches looks pretty normal.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the Help-pane behavior with the nbdev-generated ghapi package using pip install ghapi, then run from ghapi.all import GhApi and inspect GhApi.create_branch_empty? alongside GhApi.list_branches. Trace the Help rendering entry point and compare how both references are resolved; done means nbdev-generated function references render consistently rather than exposing a notebook reference unexpectedly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter, python, typescript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100