Update specification-reference.md: Removes homepage suggestion under metadata#391
Update specification-reference.md: Removes homepage suggestion under metadata#391jkylekelly wants to merge 1 commit into
homepage suggestion under metadata#391Conversation
Removes homepage from metadata since it is a dedicated attribute
|
I think this makes sense, however, there is a metadata attribute too for the homepage and it actually takes priority over the dedicated attribute. We have some issues about it in rubygems.org, see rubygems/rubygems.org#5544 or rubygems/rubygems.org#4924. I think this documentation change may actually make those issues more common, so we should probably try fix the linked issues first before changing docs? |
|
@deivid-rodriguez I wasn't aware of the issues mentioned - Agreed that they should probably be fixed first! Surprised to learn the metadata attribute takes priority. |
|
I think there is a warning if |
|
One issue is that homepage is overloaded with functionality tied to the GitHub stars feature.
The tight integration and priority of GitHub is problematic for some people. |
|
@jkylekelly Not sure your final goal, but deprecating some metadata may be a large effort. As the author of rubygems/rubygems.org#1234 - I can tell you that I did not intend on having If your goal is to deprecate @pboiling Think this is a separate conversation. Maybe you can propose this in an issue over in rubygems or rubygems.org and see if you can get a good discussion and some traction over there. Or you may want to create a PR that does gitlab stars if |
This pull request updates the
specification-reference.mdfile to revise the metadata section of the gem specification. The change removes references to the gem’s homepage from both the explanatory text and the example metadata.As a first time reader, I was shocked that homepage was suggested under metadata. But then I realized it did in fact have a dedicated attribute. Suggesting to remove it from the metadata example to reduce confusion.