search

ponnhide / pyCircos

python Circos
GNU General Public License v3.0
339 stars 66 forks source link

Within-code docstrings? #8

Open DanNBullock opened 2 years ago

DanNBullock commented 2 years ago

I've noticed that the code in pycircos.py and noticed that the current version of this file doesn't include within-code doc-strings for the relevant definitions. However, the readme document features a very comprehensive and useful documentation of these (that is also PEP 8 / 257 compliant?)

Is this an intentional omission? Alternatively, would you be interested in someone transcribing these in the pertinent locations? There may well be an automated method for doing this (or an alternate version with this already done), but if not, I could produce a version with this as I work through commenting my fork of the code (attempting to make variations for neuroscience-related applications).

ponnhide commented 2 years ago

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).

DanNBullock commented 2 years ago

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.