Deduplicate the documentation

deadpixi / contracts

An implementation of contracts for Python.

GNU Lesser General Public License v3.0

342 stars 18 forks source link

Deduplicate the documentation #23

Closed nbraud closed 5 years ago

nbraud commented 5 years ago

[x] Make setup.py pull the long description from README.rst rather than dpcontracts.__doc__.
[x] Declare it to be reStructuredText.
[x] Remove the duplicate in dpcontracts, closing #12.
[x] Deduplicate some more metadata.

nbraud commented 5 years ago

@deadpixi FYI, switching to setup.cfg for the package metadata, long_description can be set to file: README.rst rather than reading it manually from setup.py.

It's however a somewhat more-invasive change so I held off from doing it. PS: Submitted as #24.

deadpixi commented 5 years ago

Thanks for this, but I think we should keep the docstring in the module, since it allows us to use the doctest module for testing.

(I know, I know, I'm the only person left who likes doctest...)