PyHealth icon indicating copy to clipboard operation
PyHealth copied to clipboard

Update document to reflect the changes in v2.0

Open zzachw opened this issue 9 months ago • 3 comments

  1. Update the doctoring in python files
  2. Update the GitHub README
  3. Update the readthedoc web

zzachw avatar Apr 09 '25 20:04 zzachw

Hello @zzachw,

I am a newcomer here and would like to make a contribution towards this issue as I get a more understanding of the repo. I see the change on the readthedoc web has been implemented. What exact changes need to be incorporated into README and the python files?

muchemicarol avatar Sep 09 '25 11:09 muchemicarol

Hey Muchemicarol,

There's a bunch of documentation that needs to be written. If you look at the current GitHub repo, you might see some models and modules missing from the readthedocs like the interpret module. Other challenges exist like some of the tasks might not be as well-defined nor with a lot of examples.

We also need a testing/ documentation for the unit tests. All of those go under tests/core.

These while mundane, are actually pretty important in getting some of our test driven development done.

jhnwu3 avatar Sep 09 '25 14:09 jhnwu3

Hey @jhnwu3,

Thanks for the clarification! Let me review once again with this information and work on it.

muchemicarol avatar Sep 09 '25 14:09 muchemicarol