spec icon indicating copy to clipboard operation
spec copied to clipboard

Extract descriptive metadata from docstrings

Open kba opened this issue 6 years ago • 1 comments

In addition to or replacing the ocrd-tool.json fields or README, it might make sense to encourage proper python documentation with docstrings on modul level at least for the processors and use that information for the generation of documentation.

kba avatar Jul 16 '19 12:07 kba

I am not sure we need this as part of the specs anymore. It has been implemented in core already, but since this applies to internal of Python implementations, I don't think it should be described here.

Some of the proposals in https://github.com/OCR-D/core/issues/537 are more far-reaching than docstrings, though – dumping READMEs, repo URLs, license information on request.

bertsky avatar Dec 22 '21 20:12 bertsky