Skip to content

Conversation

@DarkaMaul
Copy link
Contributor

For more context, see my comment from the issue thread

The fix is simply to consider that every value of description that evaluates to False are considered as valid for an empty description.

Copy link
Member

@jaraco jaraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Should an associated test be added to protect the behavior?

Signed-off-by: Alexis <[email protected]>
@DarkaMaul
Copy link
Contributor Author

I've added a backstop-test.

I've tried to keep changes contained, but feel free to rewrite them.

@sigmavirus24
Copy link
Member

Can you fix the falling CI jobs?

@sigmavirus24 sigmavirus24 merged commit 2b33343 into pypa:main Oct 31, 2024
23 checks passed
@DarkaMaul DarkaMaul deleted the dm/fix-908 branch October 31, 2024 13:02
raydouglass pushed a commit to rapidsai/cuvs that referenced this pull request Dec 3, 2024
Wheel-building CI jobs are failing like this:

> Checking
final_dist/cuvs_cu12-25.2.0a26-cp310-cp310-manylinux_2_28_aarch64.whl:
FAILED due to warnings
> WARNING `long_description` missing.
> Error: Process completed with exit code 1.

([build
link](https://github.com/rapidsai/cuvs/actions/runs/12133882036))

Looks like the root cause is a combination of the following:

* there was a new `twine` release (6.x) 3 days ago:
https://pypi.org/project/twine/#history
* it contains pypa/twine#1168, which makes
`twine check --strict` fail if the wheel's `long_description` is empty
* the `cuvs` wheel README (used as the wheel `long_description`) is
empty

This proposes adding a small README, with just 2 sentences copied from
the project's root-level README, to get past that check.

## Notes for Reviewers

The `long_description` becomes the project homepage when a project is
hosted on PyPI. The wheels produced from this repo aren't currently
being published to pypi.org so this change won't be seen there, but a
more user-friendly README should be added if/when we decide to publish
`cuvs-cu{11,12}` to pypi.org.

ref: rapidsai/build-planning#70
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants