Indentation characters of the original code are not preserved
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 72/100
Línea de trabajo
Comience con _do_add_formatted_docstring y _do_add_unformatted_docstring, y después inspeccione _do_format_code y su uso de tokenize.untokenize. Ejecute con docformatter el reproductor proporcionado con sangría mediante tabulaciones y verifique que las tabulaciones dentro de los docstrings y en las líneas de continuación de código sigan siendo tabulaciones mientras el formateo continúa funcionando.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
docformatter unnecessarily replaces tab characters with spaces. When a file
uses tabs, running docformatter on it changes indentation characters both
inside docstrings and in code outside the docstring.
Reproducer
def some_function(
a_parameter
):
"""Important documentation.
with an indented item
"""
...
$ docformatter file.py
--- before/file.py
+++ after/file.py
@@ -1,8 +1,8 @@
def some_function(
- a_parameter
+ a_parameter
):
"""Important documentation.
- with an indented item
- """
+ with an indented item
+ """
...
Cause
Two independent code paths substitute spaces for the original indentation
characters:
-
_do_add_formatted_docstringand_do_add_unformatted_docstringbuild
the indent for the docstring's internal lines as" " * token.start[1],
based on the docstring's opening line. When the opening line is indented with
a tab, each tab inside the docstring is replaced by a single space. -
_do_format_coderuns the whole file throughtokenize.untokenize,
which reconstructs inter-token whitespace as" " * col_offset. This means
that tabs on continuation lines are also replaced by a single space.
- Lenguaje dominante
- Python
- Estrellas
- 598
- Forks
- 93
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Aún no hemos revisado los archivos de configuración de este proyecto. 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 2/5 1-3 horas Aptitud para principiantes 88/100
PyCQA/docformatter#383 ·
-
fresh
Dificultad 3/5 1-2 días Aptitud para principiantes 78/100
PyCQA/docformatter#385 ·
-
fresh
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
PyCQA/docformatter#377 ·
-
C: convention P: bug U: high
Dificultad 3/5 1-2 días Aptitud para principiantes 74/100
PyCQA/docformatter#367 · 1 comentario ·
-
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 ·
Todos los issues de PyCQA/docformatter
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 1 día
-
https://search.utilibre.orgAbiertoinstance instance add
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
searxng/searx-instances#941 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
FluidNumerics/fluid-walk-blocker#89 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día