Stop using the README as long description in the various setup.py #507
Labels
🖧 Devops
Operations, monitoring, maintenance, deployment, packaging
📄 Documentation
Internal or public documentation
📈 Improvement
Improvement of a feature.
🟧 Priority: High
Must be addressed as soon
Milestone
In all the
setup.py
files (config, gui, core, rest, taipy, templates), the long_description is populated with the README.md content.This is NOT a good practice since the long description represents a description of the package built. It is used in Pypi to describe the package. The readme is also exposed as the landing page of the repo and used as instructions on how to use the code base. These have different purposes and different lifecycles. The content should be different.
The general idea is to split the use cases:
The text was updated successfully, but these errors were encountered: