Skip to content
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

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

add metadata #308

wants to merge 1 commit into from

Conversation

noraj
Copy link

@noraj noraj commented Feb 24, 2021

will add links to rubygems & rubytoolbox

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',
Copy link
Owner

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?"

Copy link
Author

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

lsegal/yard#1187

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.

None yet

2 participants