ENH: Make behaviour clear when some garbage files are in src directory
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- latex, python
- 领域
- build-system
调研方向
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.
由索引模型根据 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.
- 主要语言
- Python
- 星标
- 9
- 派生
- 2
- 平均合并
- 1 天 11 小时
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
pytask-dev/pytask-latex 的其他 Issue
-
documentation
难度 2/5 1-3 小时 新手友好度 50/100
pytask-dev/pytask-latex#14 ·
查看 pytask-dev/pytask-latex 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
spec-kitty/spec-kitty#5319 ·
维护者通常 1 天内回复
-
backend::vllm diffusion multimodal
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
openai/openai-agents-python#5229 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复