Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add YARD docs to Faker::String #2004

Merged
merged 2 commits into from
May 23, 2020
Merged

Add YARD docs to Faker::String #2004

merged 2 commits into from
May 23, 2020

Conversation

danielTiringer
Copy link
Contributor

Issue#

#1762

Description:

Add complete YARD docs for Faker::String methods.

@danielTiringer
Copy link
Contributor Author

danielTiringer commented May 21, 2020

Some of the symbols listed in the documentation's examples aren't ascii.
Rubocop doesn't like that: Style/AsciiComments: Use only ascii symbols in comments.
Please advise if you think I should prune those out or even replace with something complex-looking but compliant. Or turn off rubocop for those lines.

@Zeragamba
Copy link
Contributor

I think it's important to show that utf8 characters are returned, and I would prefer to see their visual representation instead of an encoded one. I think we can ask robocop to back off a bit there.

@Zeragamba
Copy link
Contributor

Looks good to me. We should have a looks to see if we can tell YARD to ignore robocop commands.

@Zeragamba Zeragamba merged commit b77c6c0 into faker-ruby:master May 23, 2020
@connorshea connorshea mentioned this pull request May 31, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants