DEV Community

loading...

Discussion on: 3.76% Python packages have no summary

Collapse
patarapolw profile image
Pacharapol Withayasakpunt

The most common way to include it in the packages is to add a field called description to the setup function in the setup.py of the project. (Not to be confused with the long_description.)
In setup use the field description to provide a one-line description that will become the summary field in the JSON file.

In setup use the field long_descrption to provide, well, a long description that will become the description field in the JSON file.

Yes, I know the naming is a bit confusing.

Yes, it is very confusing. Is it Summary, or Description in the first place?