NiftyPET / NIPET

High-throughput PET image reconstruction with high quantitative accuracy and precision
Apache License 2.0
29 stars 8 forks source link

Documentation on outputs from function #7

Open davecash75 opened 5 years ago

davecash75 commented 5 years ago

HI Pawel- I think it would really help if you stuck in the comments at the beginning of your function definitions what they return, particularly in the cases where you are returning a dictionary with a lot of different entries. For example, the output dictionary of mmrchain. The input is really well documented, but people may also want to use stuff from the output too, especially since many people will run that function from their own script. Thanks Dave