[FR] Make it easier to show source in docs for thin classes
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- jupyter, python
- Ambito
- documentation
Direzione di ricerca
Inizia dal punto di ingresso show_doc di nbdev e riproduci l’esempio Colors per esaminare come viene attualmente renderizzata una classe sottile. Segui il percorso di rendering della documentazione, quindi verifica che una variante opt-in con full_source=True mostri il codice sorgente completo della classe, mentre il comportamento esistente di show_doc(Colors) rimanga invariato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Minimally reproducible example:
from enum import Enum # StrEnum for python >= 3.12
from nbdev import show_doc
class Colors(str, Enum): # Or `StrEnum` if on python >= 3.12
"Enum with the valid colors we can use in our package"
RED = "red"
GREEN = "green"
BLUE = "blue"
show_doc(Colors)
Issue description
This it not really a bug, more like a feature request. When defining thin classes, such as enums or dataclasses, the documentation for those classes shows a very uninformative ClassName (*values).
For this use case, it would be really useful to have an option that would allow inlining the entire class source in the docs, to get a view of all the possible values. To avoid breaking existing code this could be implemented as an optional argument to the show_doc method, so to enable this one would do something like show_doc(Colors, full_source=True)
- Lingua principale
- Jupyter Notebook
- Stelle
- 5.3k
- Fork
- 517
- Merge medio
- 1m
- PR unite (30g)
- 3
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsForse già presa @ruchi-mish90 l’ha presa 86 giorni fa. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
AnswerDotAI/nbdev#1596 · 1 commento ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Forse già presa @mrexodia l’ha presa 10 giorni fa. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
AnswerDotAI/nbdev#1584 · 1 commento ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
AnswerDotAI/nbdev#1583 · 1 commento · 1 reazione ·
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 52/100
AnswerDotAI/nbdev#1581 ·
Tutte le issue di AnswerDotAI/nbdev
Issue simili
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
I maintainer di solito rispondono entro 4 giorni
-
Перевод устарел
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Incorrect Link in README.mdAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
flameshot-org/flameshot#4996 ·
I maintainer di solito rispondono entro 2 giorni
-
docs(evals): note CLAUDE_CODE_PRINT_BG_WAIT_CEILING_MS for headless eval runs that use workflowsApertagood first issue needs-triage priority: low
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
melodic-software/claude-code-plugins#7022 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno