pyopenms_viz icon indicating copy to clipboard operation
pyopenms_viz copied to clipboard

Update Parameters in documentation

Open jcharkow opened this issue 9 months ago • 4 comments

With new refactoring, the parameters in the documentation might be out of date. Double check this by comparing the parameters in the _config.py class with those outlined in the documentation. See docs/Parameters folder.

Also, any ideas on how to automate this process in the future when parameters are changed are welcome!

jcharkow avatar Mar 04 '25 14:03 jcharkow

Thanks ! I'll review _config.py and compare the parameters with the documentation in docs/Parameters to ensure everything is up to date.

To automate this process , I can implement a script that checks for discrepancies between _config.py and the documentation. Additionally, integrating a Git pre-commit hook can help catch mismatches before committing changes. Let me know if you’d like me to proceed with this approach:)

Imama-Kainat avatar Mar 05 '25 13:03 Imama-Kainat

Sounds good to me!

jcharkow avatar Mar 06 '25 13:03 jcharkow

Image

Imama-Kainat avatar Mar 07 '25 15:03 Imama-Kainat

Image I have aligned the parameters with the config file and tested it by rendering with Read the Docs. Now, I am working on a script to automate the process.

Imama-Kainat avatar Mar 07 '25 15:03 Imama-Kainat