Option to not format module description docstring
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 42/100
Línea de trabajo
En el issue no se mencionan archivos ni tests. Empieza por localizar el análisis de opciones de docformatter y el código que da formato a los docstrings de descripción del módulo; después, inspecciona los tests existentes para las opciones de formato. La tarea estará terminada cuando una opción configurable por el usuario omita el docstring de descripción del módulo, mientras los demás docstrings del módulo sigan recibiendo formato.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
My organisation currently has a license header which doesn't conform to PEP 257, but I'd love to use docformatter for the rest of the module's contents.
I attempted to do this using the range option, but since the module description string also contains the module's description, one can know a minimum length for them, but not a maximum length.
It would be really great if docformatter had an option to toggle formatting of these module docstrings.
Thanks!
- Lenguaje dominante
- Python
- Estrellas
- 598
- Forks
- 97
- Merge medio
- 1 d 8 h
- PR fusionados (30 d)
- 11
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 PyCQA/docformatter
-
fresh
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
PyCQA/docformatter#399 ·
Los mantenedores suelen responder en 1 día
-
1.7.8 crashes with a tokenize ValueError on a multi-line f-string inside parenthesesQuizá libre de nuevo @adityaanikam la tomó hace 75 días y no hay ningún pull request abierto. AbiertoC: convention P: bug U: high
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
PyCQA/docformatter#367 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
1.7.8 rewrites the contents of a non-docstring triple-quoted string, silently changing its valueAbiertoC: convention P: bug U: high
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
PyCQA/docformatter#366 ·
Los mantenedores suelen responder en 1 día
-
C: stakeholder P: enhancement U: low
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
PyCQA/docformatter#346 ·
Los mantenedores suelen responder en 1 día
-
C: convention P: bug U: high
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
PyCQA/docformatter#345 · 1 reacción ·
Los mantenedores suelen responder en 1 día
Todos los issues de PyCQA/docformatter
Issues similares
-
intake mcp-intake needs-ac needs-human-review priority:medium
Dificultad 2/5 1-3 horas Aptitud para principiantes 67/100
Ikalus1988/MisakaNet#3848 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
521xueweihan/HelloGitHub#4105 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
igormcsouza/bookloud#54 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
aws-samples/sample-per-model-bedrock#526 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
ok-oldking/ok-wuthering-waves#1802 ·
Los mantenedores suelen responder en 2 días