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

API docs: Fix YARD warnings #331

Merged
merged 1 commit into from
Dec 30, 2019
Merged

API docs: Fix YARD warnings #331

merged 1 commit into from
Dec 30, 2019

Conversation

olleolleolle
Copy link
Contributor

@olleolleolle olleolleolle commented Mar 29, 2019 •
edited
Loading

Description

This PR avoids 2 YARD warnings output when generating documentation, by using the right parameter names.

lib/chef-vault/item.rb:441: [UnknownParam] @param tag has unknown parameter name: client
lib/chef-vault/item.rb:463: [UnknownParam] @param tag has unknown parameter name: client_or_node

Issues Resolved

...

Check List

@olleolleolle
Fix YARD warnings
7495c90 
Signed-off-by: Olle Jonsson <olle.jonsson@gmail.com>
@olleolleolle olleolleolle requested a review from a team March 29, 2019 19:10
@tas50 tas50 merged commit f6665e9 into chef:master Dec 30, 2019
@tas50
Copy link
Contributor

tas50 commented Dec 30, 2019

Thanks @olleolleolle

@olleolleolle olleolleolle deleted the fix/yard-warnings branch December 30, 2019 18:57
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
@olleolleolle @tas50