ho-tex / rerunfilecheck

rerunfilecheck for LaTeX
LaTeX Project Public License v1.3c
2 stars 0 forks source link

documentation: \usepackage[aux]{rerunfilecheck} activates all checks #3

Open Reissner opened 1 year ago

Reissner commented 1 year ago

When reading the package documentation, section 1.1, then I read on option aux:

All options are key value options of boolean type. No option or true turns an option on, false disables an option. Specifically on option aux I read: aux: This option turns all previous options on or off. “aux” means auxiliary file.

And finally: The default for the options is false, because some internals must be redefined to insert the rerun checks.

If I understand this right, then \usepackage[aux]{rerunfilecheck} is equivalent with \usepackage[aux=false]{rerunfilecheck} and turns all checks off and \usepackage{rerunfilecheck} is equivalent with \usepackage[aux=true]{rerunfilecheck} and turns all checks on.

This is not the behavior. It seems as if \usepackage[aux]{rerunfilecheck} is equivalent with \usepackage[aux=true]{rerunfilecheck} and turns all checks on and \usepackage{rerunfilecheck} is equivalent with \usepackage[aux=false]{rerunfilecheck} and turns all checks off.

I think, just documentation must be changed.

davidcarlisle commented 1 year ago

aux is described as boolean type, that means that an option foo is like foo=true and not using the option is like foo=false We could perhaps clarify the doc a bit but I think that is explictly what the description of boolean options that you quoted says.