Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Script modifies certain utility files which it shouldn't #5

Open
osanstrong opened this issue Aug 25, 2024 · 0 comments
Open

Script modifies certain utility files which it shouldn't #5

osanstrong opened this issue Aug 25, 2024 · 0 comments
Assignees
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

Comments

@osanstrong
Copy link
Collaborator

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 file acros.tex. However, the script treats acros.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:

\newacronym{FHR}{FHR}{Fluoride-Salt-Cooled High-Temperature Reactor}
\newacronym{FLiBe}{FLiBe}{Fluoride-Lithium-Beryllium}
\newacronym{FHR}{FHR}{\colorbox{teal}{Fluoride-Salt}\footnote{5g: Two words joined by a hyphen in title case should both be capitalized.}-Cooled \colorbox{teal}{High-Temperature}\footnote{5g: Two words joined by a hyphen in title case should both be capitalized.} Reactor}
\newacronym{FLiBe}{FLiBe}{\colorbox{teal}{Fluoride-Lithium}\footnote{5g: Two words joined by a hyphen in title case should both be capitalized.}-Beryllium}

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 package xcolor is used, and/or clearly allowing the user to easily define how the script should treat project files using some kind of configuration file.

@osanstrong osanstrong added 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 labels Aug 25, 2024
@osanstrong osanstrong self-assigned this Aug 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant