[FR] Make it easier to show source in docs for thin classes
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- jupyter, python
- Área
- documentation
Línea de trabajo
Comienza en el punto de entrada show_doc de nbdev y reproduce el ejemplo Colors para inspeccionar cómo se renderiza actualmente una clase delgada. Sigue la ruta de renderizado de la documentación y verifica después que una variante opt-in con full_source=True muestre el código fuente completo de la clase, mientras que el comportamiento existente de show_doc(Colors) permanece sin cambios.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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)
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 5.3k
- Forks
- 517
- Merge medio
- 1 min
- PR fusionados (30 d)
- 3
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de AnswerDotAI/nbdev
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword ArgumentsPosiblemente ocupada @ruchi-mish90 la tomó hace 85 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
AnswerDotAI/nbdev#1596 · 1 comentario ·
-
`great-docs` by Posit Is here!Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?Posiblemente ocupada @mrexodia la tomó hace 9 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1584 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
AnswerDotAI/nbdev#1583 · 1 comentario · 1 reacción ·
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
AnswerDotAI/nbdev#1581 ·
Todos los issues de AnswerDotAI/nbdev
Issues similares
-
bug
Dificultad 2/5 Menos de una hora Aptitud para principiantes 82/100
awslabs/visual-asset-management-system#413 ·
Los mantenedores suelen responder en 1 día
-
good first issue hacktoberfest
Dificultad 2/5 Medio día Aptitud para principiantes 70/100
HelpCode-ai/anythingmcp#996 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
zerocracy/judges-action#2730 ·
Los mantenedores suelen responder en 8 días
-
documentation good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
afarber/OpenMapView#21 ·
-
[workshop-sim] Improve: Add a required self-check gate to the agentic-workflows concept pageAbiertofeedback simulation workshop
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
githubnext/gh-aw-workshop#4417 ·
Los mantenedores suelen responder en 1 día