The `setup.py` parse-info method treats description/long_description keys wrongly

Bug #1813364 reported by 林博仁(Buo-ren, Lin)
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Snapcraft
In Progress
Undecided
Unassigned

Bug Description

According to the [setuptools documentation](https://setuptools.readthedocs.io/en/latest/setuptools.html?highlight=long_description#id54) the `description` key is equivalent to Snapcraft's `summary` key and the `long_description` key is equivalent to Snapcraft's `description` key, however currently Snapcraft uses the `description` key's value as the snap description and ignores the `long_description` key in setup.py, I would like to request changing the behavior to match with setuptools.

Revision history for this message
林博仁(Buo-ren, Lin) (buo-ren-lin) wrote :
Changed in snapcraft:
status: New → In Progress
Revision history for this message
Merlijn Sebrechts (merlijn-sebrechts) wrote :

`long_description` isn't actually a good candidate for the `description` field in snapcraft because the text is actually used for the project homepage on pypi (and often also on Github).

As a result, many applications start `long_description` by explaining how to install the software on Windows, Mac an Linux. It's also often in an incompatible format and too long for the `description` field.

More info: https://github.com/snapcore/snapcraft/pull/2756#issuecomment-544284814

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.