AnswerDotAI / AnswerDotAI/nbdev

Can't document static / constant variables?

Open
#1,355 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Jupyter Notebook
Stars
5.3k
Forks
513
Avg merge
2d 30m
Merged PRs (30d)
8

Description

```python
from nbdev import show_doc

# this gets ignored
MY_CONST = 'hello' # this gets ignored

# this shows hello not MY_CONST
showdoc(MY_CONST)
```

Contributor guide

Open the contributing guide

Research direction

Reproduce the notebook example using nbdev.show_doc and the MY_CONST assignment, then inspect the show_doc entry point and its handling of constant values. Done means the constant is documented with its name and intended value rather than being ignored or displayed only as hello.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.