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

Documentation bug: replacements for deprecated keywords can be hard to find #762

Open
EzryStIago opened this issue Jan 17, 2025 · 1 comment

Comments

@EzryStIago
Copy link
Contributor

I'm using some config files that use older parameters:

  • targetForceExponent
  • centerReference
  • rotateReference

NAMD provides the warning:
Warning: keyword targetForceExponent is deprecated. Check the documentation for the current equivalent.

But these keywords are no longer in the ColVars documentation so it's harder to find the replacement. Just a note in the relevant sections so a ctrl-F can find the new keyword would be helpful.

Maybe something like:

lambdaExponent — Exponent in the time-dependence of the force constant
Default: 1.0 [ decimal equal to or greater than 1.0, context: harmonic ]
Formerly: targetForceExponent

Sets the exponent, α, in the function used to vary the force [...]

@giacomofiorin
Copy link
Member

Hi @EzryStIago! I think we simply forgot to add the deprecated keyword in the section dedicated to that purpose:
https://colvars.github.io/master/colvars-refman-namd.html#sec:colvars_config_changes

@EzryStIago EzryStIago changed the title Documentation bug: replacements for deprecated keywords are can be hard to find Documentation bug: replacements for deprecated keywords can be hard to find Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants