I like how you once said that the docstring for a Python package or module should explain why it is there. It looks like the docstring in the checkbox.shadowd package tries to explain what it is doing, which would probably be better served by documentation under the doc/ directory. How would you feel about only keeping the first paragraph in that docstring?
I like how you once said that the docstring for a Python package or module should explain why it is there. It looks like the docstring in the checkbox.shadowd package tries to explain what it is doing, which would probably be better served by documentation under the doc/ directory. How would you feel about only keeping the first paragraph in that docstring?