[FR] Make it easier to show source in docs for thin classes
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- jupyter, python
- Domaine
- documentation
Piste de recherche
Commencez au point d’entrée show_doc de nbdev et reproduisez l’exemple Colors afin d’examiner comment une classe mince est actuellement rendue. Suivez le chemin de rendu de la documentation, puis vérifiez qu’une variante opt-in avec full_source=True affiche le code source complet de la classe, tandis que le comportement existant de show_doc(Colors) reste inchangé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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)
- Langage dominant
- Jupyter Notebook
- Étoiles
- 5.3k
- Forks
- 516
- Merge moyen
- 2 j 7 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsPeut-être pris @ruchi-mish90 l’a pris il y a 105 jours. Ouvertebug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
AnswerDotAI/nbdev#1596 · 1 commentaire ·
-
`great-docs` by Posit Is here!Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Peut-être pris @mrexodia l’a pris il y a 29 jours. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 35/100
AnswerDotAI/nbdev#1584 · 1 commentaire ·
-
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
AnswerDotAI/nbdev#1583 · 1 commentaire · 1 réaction ·
-
bug
Difficulté 3/5 1-2 jours Accessibilité débutants 52/100
AnswerDotAI/nbdev#1581 ·
Toutes les issues de AnswerDotAI/nbdev
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
open-horizon/devops#237 ·
-
GPU-UNLOCK RTX 4070 (2786) Gigabyte 1458:416C: cold boot AND warm reboot unlock, Ubuntu 26.04Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
JustAResearcher/gpu-unlock-ada#124 ·
Les mainteneurs répondent en général sous 1 jour
-
help wanted
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 80/100
Les mainteneurs répondent en général sous 1 jour
-
documentation good first issue help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
satyrn-ai/satyrn-website#52 ·
Les mainteneurs répondent en général sous 1 jour