search

OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
45 stars 54 forks source link

Mentioning that "plot_spectrum" function has been named differently #341

Closed JeeH-K closed 1 year ago

jpfeuffer commented 1 year ago

Ideally, this should be in the Changelog instead.

timosachsenberg commented 1 year ago

Do we have a proper pyOpenMS changelog? Or worries we need to add something to the readthedocs page? Btw I have seen these kind of “API has changed” or “compatibility notes” before in other projects and found them helpful. What is your main concern here? Clutter?

jpfeuffer commented 1 year ago

Yes clutter. If we do this for every change, it will become completely unreadable. It will be unreadable already, if we actually added all changes to the API since 2.X right now.

jpfeuffer commented 1 year ago

And where to add it? Everytime plotting is mentioned in the docs? This is just not scalable. The maximum I would agree with is in the module API documentation.

jpfeuffer commented 1 year ago

You can also write a migration guide or something like that. But IMHO this is basically an extended changelog then.

timosachsenberg commented 1 year ago

OK, I agree that this can escalate quickly :) I would be fine with either put this note in: https://pyopenms.readthedocs.io/en/latest/_autosummary/pyopenms.plotting.html#module-pyopenms.plotting or provide a good answer in the issue so people can also look it up through the issue tracker...

jpfeuffer commented 1 year ago

Problem is, the user asked on discussions and issues. I answered on discussions and refused to answer twice.

jpfeuffer commented 1 year ago

I edited the last reply now and it should be clear from the issue.

timosachsenberg commented 1 year ago

🙏