Giter Site home page Giter Site logo

Within-code docstrings? about pycircos HOT 2 OPEN

ponnhide avatar ponnhide commented on September 8, 2024
Within-code docstrings?

from pycircos.

Comments (2)

ponnhide avatar ponnhide commented on September 8, 2024

Thank you for your comment.
I have a plan to do it. However, I'm a beginner as an OSS developer, and my English writing skill is poor... In fact, I think the current readme document still includes many things to be rewritten.
So, I still cannot start to manage the 'docstring' thing and need much time.

Anyway, If you want to do such kind of thing in your forked repository, you are welcome to do so (since I don't know about neuroscience well, since my major studying is genomics).

from pycircos.

DanNBullock avatar DanNBullock commented on September 8, 2024

I've added the docstrings from your readme here, and also made a couple of code changes as noted. There are a few undocumented components of the process (e.g. spine) that I couldn't figure out myself, but it seems quite well and broadly documented as is (even if you may be changing things in the future). I think the clarity was/is quite good (and that you may be underestimating your English writing skill), but in any case, if I can be of any use in the future just let me know (this is a great project/ application). Alternatively, if this sort of input / GitHub pull request isn't what you're looking for, that's perfectly fine too.

from pycircos.

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.