Skip to content

Update specification-reference.md: Removes homepage suggestion under metadata #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkylekelly
Copy link

This pull request updates the specification-reference.md file 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.

Removes homepage from metadata since it is a dedicated attribute
@deivid-rodriguez
Copy link
Member

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?

@jkylekelly
Copy link
Author

@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.

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.

2 participants