-
Notifications
You must be signed in to change notification settings - Fork 105
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
add metadata #308
add metadata #308
Conversation
will add links to rubygems & rubytoolbox
@@ -12,6 +12,15 @@ spec = Gem::Specification.new do |s| | |||
s.summary = "Build command-suite CLI apps that are awesome." | |||
s.description = "Build command-suite CLI apps that are awesome. Bootstrap your app, add commands, options and documentation while maintaining a well-tested idiomatic command-line app" | |||
|
|||
s.metadata = { | |||
'yard.run' => 'yard', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's this one do? Is it just "what command do I run to do yard doc generation?"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can also add the following to your .gemspec to have YARD document your gem
on install:spec.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
or
Closing due to being very old. |
Why closing it? It's still relevant. No metadata has been added to the gemspec in the meantime. I also answered to the question you asked in the review. |
Yeah, agreed it's still relevant. I still don't understand what the yard key is for since this project doesn't use yard. I took your PR, then changed it to remove the yard key, correct one of the URLs and add a wiki link: See #328 Thanks for the nudge! |
Released in 2.21.4 |
will add links to rubygems & rubytoolbox