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

Incorrect default values for optional arguments in Lorem Documentation #1635

Closed
mikong opened this issue Jun 18, 2019 · 0 comments · Fixed by #1636
Closed

Incorrect default values for optional arguments in Lorem Documentation #1635

mikong opened this issue Jun 18, 2019 · 0 comments · Fixed by #1636

Comments

@mikong
Copy link
Contributor

mikong commented Jun 18, 2019

The default values for paragraph is incorrect here:

# Optional arguments: sentence_count=3, supplemental=false, random_sentences_to_add=3
# The 'random_sentences_to_add' argument increases the paragraph's sentence count by a random value within (0..random_sentences_to_add).
# To specify an exact sentence count for a paragraph, set sentence_count to the number you want and random_sentences_to_add equal to 0.
# By default, sentences will have a random number of words within the range (3..6).
Faker::Lorem.paragraph [...truncated...]

It should be:

# Optional arguments: sentence_count=3, supplemental=false, random_sentences_to_add=0

Also, the default values for question and questions is different so they should be separated. Currently:

# Optional arguments: question_count = 3, supplemental = false
Faker::Lorem.question #=> "Aliquid culpa aut ipsam unde ullam labore?"
Faker::Lorem.questions(3) #=> ["Necessitatibus deserunt animi?", "At hic dolores autem consequatur ut?", "Aliquam velit ex adipisci voluptatem placeat?"]

It should be:

# Optional arguments: word_count=4, supplemental=false, random_words_to_add=0
Faker::Lorem.question #=> "Aliquid culpa aut ipsam unde ullam labore?"

# Optional arguments: question_count=3, supplemental=false
Faker::Lorem.questions(3) #=> ["Necessitatibus deserunt animi?", "At hic dolores autem consequatur ut?", "Aliquam velit ex adipisci voluptatem placeat?"]

The example output should also be changed to reflect the correct defaults.

I'm currently working on the PR for this.

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 a pull request may close this issue.

1 participant