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.

Sign up for GitHub

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

Jump to bottom

README modifications #1

Closed
wants to merge 10 commits into from
Closed

README modifications #1

wants to merge 10 commits into from

Conversation

dwaynemac
Copy link

I modified minor details to the README file according to some difficulties I had when trying to use this plugin.

dwaynemac and others added 10 commits February 20, 2012 17:14
@dwaynemac
running with '*.rb' isn't generating docs
a97af08
@dwaynemac
doc
1aba993
@dwaynemac
according to lib/yard-rest/rest_filters.rb:25 @overall is ignored.
2f3ae8a 
adding this to README
@dwaynemac
Add new tag @key_for
13284aa 
It is the equivalent to @option for an argument
@dwaynemac
new tag @value_for
ea187ee 
works like @option but used for non-hash arguments.

Example:

@argument [String] scope

@value_for scope 'pending'
@value_for scope 'done'
@dwaynemac
add @value_for to README
71beba5
@bitti
Add necessary template files to gemspec
bd42252
@dwaynemac
Merge pull request #2 from bitti/master
37f016c 
Add necessary template files to gemspec
@dwaynemac
update installation readme for this fork.
2ea894a
@dwaynemac
Update README.markdown
33ac0b0 
fix README tags documentation
@dwaynemac dwaynemac closed this Sep 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dwaynemac @bitti