Add explicit name attribute to all packages

matplotlib / mpl-third-party

Third-party Packages Webpage

https://matplotlib.org/mpl-third-party/

53 stars 70 forks source link

Add explicit name attribute to all packages #137

Closed timhoffm closed 1 year ago

timhoffm commented 1 year ago

This:

save us from having to figure out the project name from a repository location, which will become more complicated when we accept non-GitHub repos (#100).
allows using whitespace and arbitrary capitalization in the project name (which might be spelled differently than the repository name).

jklymak commented 1 year ago

This is fine, though it seems redundant for 99% of packages. I would make it optional for the packages that want a name different than the repo or don't have a repo.

timhoffm commented 1 year ago

Can you please also update the readme template?

@story645 What do you miss?

story645 commented 1 year ago

@timhoffm sorry yeah I thought the first one was cmocean

timhoffm commented 1 year ago

This is fine, though it seems redundant for 99% of packages. I would make it optional for the packages that want a name different than the repo or don't have a repo.

IMHO there is value in making this mandatory. With a mandatory name, we can get rid of any repo parsing. Having distinct unrelated attributes is both simpler in code and simpler to explain to the end user (Understanding "Name is optional, if not given we extract it from repo" is much more effort than typing your project name).