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

rubocop: fix Style/Documentation offenses #951

Merged
merged 6 commits into from Mar 21, 2019
Merged

Conversation

technoweenie
Copy link
Member

This fixes the remaining Style/Documentation offenses. Since we're likely to settle on YARD for all our docs (/cc #950), I've tried to use YARD tags where I can.

@technoweenie technoweenie mentioned this pull request Mar 20, 2019
Copy link
Member

@olleolleolle olleolleolle left a comment

Choose a reason for hiding this comment

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

I saw one tiny thing, easily fixed!

Thanks for creating new sentences where there were none! Especially the ones about Option-related classes: very clear and grounded.

module FlatParamsEncoder
class << self
extend Forwardable
def_delegators :'Faraday::Utils', :escape, :unescape
end

# Encode converts the given param into a URI querystring. Keys and values
# will converted to strings and appropriately escaped for the URI.

Copy link
Member

Choose a reason for hiding this comment

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

Missing a # mark here.

@olleolleolle olleolleolle merged commit 5063ffe into master Mar 21, 2019
@iMacTia iMacTia deleted the rubocop-style-doc branch March 21, 2019 09:08
@lostisland lostisland deleted a comment May 2, 2019
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

3 participants