search

napari / cookiecutter-napari-plugin

Cookiecutter for napari plugins
BSD 3-Clause "New" or "Revised" License
67 stars 39 forks source link

update instruction in DESCRIPTION.md to refer to napari hub wiki page #133

Closed liu-ziyang closed 2 years ago

liu-ziyang commented 2 years ago

closes #132

This PR updates the description in the placeholder file to refer to the hub page's best practices writing a description that also has good examples.

tlambert03 commented 2 years ago

perfect thank you. Would you be opposed to mentioning on that wiki page the fact that most python packaging systems will use the README as the description by default (or, depending on their setup config, they might need to specify it) . And emphasize the fact that the hub description should be used when they want to customize how it looks specifically on the hub page, but that they should not forget/neglect how their package description appears on pypi? Perhaps linking to https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/

(in general, I think we should be teaching people about python, not just about the hub)

liu-ziyang commented 2 years ago

in general, I think we should be teaching people about python, not just about the hub

Agreed! cc @neuromusic to confirm before I make any edits to the wiki page

neuromusic commented 2 years ago

love it. @potating-potato feel free to dive in on updating the napari hub wiki page accordingly.