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

Corrected and Expanded Documentation #586

Merged
merged 1 commit into from Jun 24, 2014
Merged

Corrected and Expanded Documentation #586

merged 1 commit into from Jun 24, 2014

Conversation

andreykul
Copy link
Contributor

No description provided.

@sferik
Copy link
Owner

sferik commented Jun 23, 2014

What makes you think filter_level does not exist any more?

@andreykul
Copy link
Contributor Author

I have never seen such a field in a tweet.

@sferik
Copy link
Owner

sferik commented Jun 23, 2014

It was introduced on February 13, 2013 and is only returned by the streaming API, which is why you may not have seen it.

@andreykul
Copy link
Contributor Author

I have added it back, with a note :)

:in_reply_to_attrs_id, :in_reply_to_status_id, :in_reply_to_user_id,
:lang, :retweet_count, :source, :text
# @note filter_level exists only in Streaming API
# @return [String]
Copy link
Owner

Choose a reason for hiding this comment

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

How does yard handle @note and @return on attributes?

@sferik
Copy link
Owner

sferik commented Jun 23, 2014

I’m not sure how yard will handle the attribute documentation changes. I’m also reluctant to make this change only to this one class. I’d like the documentation to be consistent throughout the library.

I’m 👍 on fixing the return types to Addressable::URI.

Also, could you please squash these commits?

@andreykul
Copy link
Contributor Author

Yard handles them really well :)

screen shot 2014-06-23 at 9 14 30 pm
screen shot 2014-06-23 at 9 14 40 pm

I would have changed the rest of the documentation to match this, but I don't know the return types of stuff all the stuff.

Mind sharing a good squashing tutorial? first time I hear about it.

@andreykul andreykul changed the title Added more precise return types for accessors. Corrected return types fo... Corrected and Expanded Documentation Jun 24, 2014
@sferik
Copy link
Owner

sferik commented Jun 24, 2014

Mind sharing a good squashing tutorial? first time I hear about it.

http://mislav.uniqpath.com/2013/02/merge-vs-rebase/

sferik added a commit that referenced this pull request Jun 24, 2014
Corrected and Expanded Documentation
@sferik sferik merged commit 3864bc7 into sferik:master Jun 24, 2014
@sferik
Copy link
Owner

sferik commented Jun 24, 2014

Thanks!

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