pydicom / deid

best effort anonymization for medical images using python

https://pydicom.github.io/deid/

MIT License

140 stars 43 forks source link

Move copyright blocks from docstrings to comments #213

Closed jstorrs closed 1 year ago

jstorrs commented 1 year ago

Description

This pull request moves the copyright blocks out of the docstrings and sets them as comments. This makes autogenerated API documentation cleaner (pydoc3, sphinx-apidoc). For example

pydoc3 -b deid

will not be cluttered with copyright blocks everywhere

Checklist

[x] I have commented my code, particularly in hard-to-understand areas
[x] My changes generate no new warnings
[x] My code follows the style guidelines of this project

Open questions

vsoch commented 1 year ago

What's so bad about having them?

jstorrs commented 1 year ago

It is annoying to have to scroll past the MIT license on every page. If you want them left in the docstring could you consider shortening it to something like:

Copyright 2008-2018 Vanessa Sochat. See LICENSE file for details.

vsoch commented 1 year ago

I hear you! And I agree. I don't like this particular style (using a #) but I've updated the files to have a format I like, and from your issue I'm also reading that we are missing the API documentation in our docs! So I've added them here https://deid.readthedocs.io/en/latest/ and they are linked from the main docs here: https://pydicom.github.io/deid/.

Thanks for request! I'm going to close here and let me know if there are other issues.