Skip to content

document how to set long_description #5069

@ppena-LiveData

Description

@ppena-LiveData
  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

The existing doc mentions readme=... for the pyproject.toml, but it doesn't tell the user that it maps to the long_description of setup.py, i.e. the Description metadata for the package.

NOTE: there was another GitHub issue about long_description, but it was closed without the documentation being updated, so I'm creating a separate ticket for this doc update work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation issues/improvements

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions