search

Roestlab / massdash

MassDash: A web-based dashboard for streamlined DIA-MS visualization, analysis, prototyping, and optimization
https://massdash.streamlit.app/
BSD 3-Clause "New" or "Revised" License
16 stars 3 forks source link

[REFACTOR] Documentation #48

Closed jcharkow closed 6 months ago

jcharkow commented 8 months ago

A lof of the stuff I refactored needs to have updated documentation. Not sure if @singjc this also applies to you?

singjc commented 8 months ago

Yeah, I've been trying to update the the documentation as I go with the refactoring, but I probably have missed some.

jcharkow commented 8 months ago

@singjc in terms of documentation what is the general format that you have been using because it would be good to be consistent. Can you point me to an example?

singjc commented 8 months ago

@singjc in terms of documentation what is the general format that you have been using because it would be good to be consistent. Can you point me to an example?

@jcharkow I think the doc strings like this InteractivePlotter::plot for methods and maybe something like this ChromatogramPlotUISettings for class docs

This is another variation of the two ExtractedIonChromatogramAnalysisUI.

But I agree, we should use consistent documentation. I would be okay with either one of those two, what do you think?

jcharkow commented 8 months ago

I like this form https://github.com/Roestlab/massseer/blob/e40ff988ec50ae961fa109f2f8392cc16855d831/massseer/plotting/InteractivePlotter.py#L28-L38 so lets use that one!

singjc commented 8 months ago

I like this form

https://github.com/Roestlab/massseer/blob/e40ff988ec50ae961fa109f2f8392cc16855d831/massseer/plotting/InteractivePlotter.py#L28-L38 so lets use that one!

Okay, sounds good!