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

Added Yardoc comments #185

Merged
merged 4 commits into from Apr 23, 2015
Merged

Added Yardoc comments #185

merged 4 commits into from Apr 23, 2015

Conversation

lslezak
Copy link
Member

@lslezak lslezak commented Apr 22, 2015

No description provided.

@mvidner
Copy link
Member

mvidner commented Apr 22, 2015

This documents a parameter that was apparently dropped:

$ yardoc
[warn]: @param tag has unknown parameter name: dir 
    in file `src/lib/registration/eula_reader.rb' near line 70

@lslezak
Copy link
Member Author

lslezak commented Apr 22, 2015

@mvidner Thanks! I run yardoc locally and it did not report any issue. After upgrading from 0.8.7.4 to 0.8.7.6 it prints the warning...

mvidner
mvidner reviewed Apr 22, 2015
View reviewed changes
src/lib/registration/downloader.rb
# is reached the download fails with RuntimeError exception
# @param file_url [String, URI] URL of the file to download
# @param insecure [Boolean] if true the SSL verification errors are ignored
# @return [String] the downloaded file
Copy link
Member

Choose a reason for hiding this comment

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

"the contents of the downloaded file"

(an alternative would be to return the filename of the contents)

@mvidner
Copy link
Member

mvidner commented Apr 22, 2015

Thanks!

I got disappointed by yard graph because the only dependencies it plots are inheritance and (optionally) module inclusion. I had hoped for a call-based dependency info, but I guess that would involve a) more parsing b) more type guessing.

@mvidner
Copy link
Member

mvidner commented Apr 23, 2015

LGTM

lslezak added a commit that referenced this pull request Apr 23, 2015
@lslezak
Merge pull request #185 from yast/yardoc
9f1e589 
Added Yardoc comments
@lslezak lslezak merged commit 9f1e589 into master Apr 23, 2015
@lslezak lslezak deleted the yardoc branch April 23, 2015 08:58
@lslezak
Copy link
Member Author

lslezak commented Apr 23, 2015

@mvidner thanks a lot for the review!

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.

None yet
2 participants
@lslezak @mvidner