Script modifies certain utility files which it shouldn't #5
Labels
Comp:Core
This issue has to do with the main bulk of the code or document. (methods, main content)
Difficulty:1-Beginner
This issue does not require expert knowledge and may be a good issue for new contributors.
Priority:1-Critical
This is the highest priority (i.e. it is blocking other work or facing a deadline).
Status:1-New
No one has claimed this issue yet. It is in need of solving.
Type:Bug
Something is wrong or broken. This issue or PR is related to a bug in code.
Type:Feature
New feature or feature request
At the time of writing this issue, the script interprets all
.tex
files in the input directory equally. This was simple to implement, but flawed in a number of ways.For example, a project may use the package
acro
, which allows writers to define acronyms with commands in a fileacros.tex
. However, the script treatsacros.tex
as if it were just part of the body of the document, and thus adds a plethora of notes and concerns about what it thinks are acronyms and contractions galore inserted into ordinary writing. This is unnecessary, and for utility.tex
files, can even cause compilation issues for viewing the final diff file.Before:
Some approach that allows for easy but meaningful distinction between the different parts of a repository is necessary. This issue can be closed when the script is modified to discriminate between
.tex
files, such as by checking for common utility names, carefully ensuring the packagexcolor
is used, and/or clearly allowing the user to easily define how the script should treat project files using some kind of configuration file.The text was updated successfully, but these errors were encountered: