Coder Social home page Coder Social logo

[REFACTOR] Documentation about massdash HOT 5 CLOSED

roestlab avatar roestlab commented on July 18, 2024
[REFACTOR] Documentation

from massdash.

Comments (5)

singjc avatar singjc commented on July 18, 2024

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

from massdash.

jcharkow avatar jcharkow commented on July 18, 2024

@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?

from massdash.

singjc avatar singjc commented on July 18, 2024

@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?

from massdash.

jcharkow avatar jcharkow commented on July 18, 2024

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

from massdash.

singjc avatar singjc commented on July 18, 2024

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!

from massdash.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.