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

doc: Repair YARD annotations #707

Merged
merged 1 commit into from
Mar 16, 2020
Merged

Conversation

olleolleolle
Copy link
Contributor

Avoid some warnings and misprints in API docs

Summary

YARD.

Details

I noted when generating docs that we had some warnings. I took a look at one of them, and managed to improve it.

lib/aruba/api/commands.rb:171: [UnknownParam] @param tag has unknown parameter name: options
lib/aruba/api/filesystem.rb:143: [UnknownParam] @param tag has unknown parameter name: file_name
lib/aruba/api/filesystem.rb:163: [UnknownParam] @param tag has unknown parameter name: source
lib/aruba/api/filesystem.rb:168: [UnknownParam] @param tag has unknown parameter name: destination
lib/aruba/api/filesystem.rb:209: [UnknownParam] @param tag has unknown parameter name: source
lib/aruba/api/filesystem.rb:214: [UnknownParam] @param tag has unknown parameter name: destination
lib/aruba/api/filesystem.rb:287: [UnknownParam] @param tag has unknown parameter name: mode
lib/aruba/api/filesystem.rb:290: [UnknownParam] @param tag has unknown parameter name: file_name
lib/aruba/api/filesystem.rb:342: [UnknownParam] @param tag has unknown parameter name: name

The unknown ones, I didn't fix here, but moved the rubocop disables, so as to stay out of documentation generation.

Motivation and Context

How Has This Been Tested?

Ran YARD locally to see changes.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (cleanup of codebase without changing any existing functionality)
  • Update documentation

Copy link
Contributor

@mvz mvz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@mvz mvz merged commit b6452b5 into cucumber:master Mar 16, 2020
@olleolleolle olleolleolle deleted the yard-annotations branch March 16, 2020 07:06
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