search

pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 88 forks source link

fix: emit a warning when no content is rendered #231

Closed miketheman closed 2 years ago

miketheman commented 2 years ago

Fixes #149

Signed-off-by: Mike Fiedler miketheman@gmail.com

miketheman commented 2 years ago

cc @bhrutledge - the bug surfaced via a twine check command - see original issue. This library hadn't previously emitted any specific warnings, rather passing through any received from docutils, so this is the first that I can tell where we're emitting our own to the stream.

bhrutledge commented 2 years ago

@miketheman Thanks for sharing, and fixing! I'd like to take a look at how this displays in Twine, and see if there could be a more helpful message. I should be able to do that later today.

miketheman commented 2 years ago

@bhrutledge I think this is now ready for re-review and release, considering that twine 4.0.0 is out with the changes to the stream.

bhrutledge commented 2 years ago

@miketheman Thanks for the nudge. It's been on my list, blocked by "real life". 😉 Hopefully this weekend.

miketheman commented 2 years ago

Thanks! @di all yours now.