Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

ENH: Make behaviour clear when some garbage files are in src directory

Abierto
  • ¿Algo no está bien?
#41 1 comentario 0 reacciones 0 asignados Ver en GitHub

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
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
latex, python
Área
build-system

Línea de trabajo

Start by reproducing the behavior with separate src and bld directories, compiling through pytask-latex and latexmk, and leaving compilation side-effect files in src. Check how the plugin detects source and build directories and handles those files. Done should mean the behavior is explicit and predictable, with the chosen handling covered by a reproducible test or documented outcome.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

good first issue

Just came across this while grading assignments, had run into it before myself:

We used \verb|pytask-latex| to compile our document -- a nice feature is that the \LaTeX\ garbage files are stored in the \verb|bld| folder, not the source folder. During the process of writing the report, however, we used source code editors (see above) which compile the document as well right in the \verb|src| folder. At this point, we noted an interesting complication: when the garbage files in the \verb|src| folder are not removed but the ones in the \verb|bld| folder are removed, then, \verb|pytask-latex| fails to compile the document in the \verb|bld| folder. It took us some experiments to figure out this behaviour but we suppose that, in this case, \verb|pytask-latex| at the first run of \verb|latexmk| thinks the garbage files in the \verb|src| folder are the relevant ones and therefore imports wrong ``settings.'' When both garbage file locations are cleaned or both of them are not cleaned, then all works well. Importantly, for unpacking the project it does not matter since we don't include the \verb|src| garbage files in the repository.

This happens easily if one has separate src/bld directories and (accidentally) tries to compile the document in the src folder. Very hard to understand what is happening then.

Not sure what should happen. In any case, first thing to do would be to check whether

  • src/bld are separate
  • and whether there are files in src that are side-effects of the compilation.

If true, possibilities I can think of:

  • Raise an explicit error (maybe with interactive option / command line suggestion to remove the files?)
  • Somehow ignore the files with side-effects in src (stash them like pre-commit does?)

Difficult thing might be to predict exactly which files will be there.

Lenguaje dominante
Python
Estrellas
9
Forks
2
Merge medio
2 d 11 h
PR fusionados (30 d)
2

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

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pytask-dev/pytask-latex

Todos los issues de pytask-dev/pytask-latex

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.