Skip to content

Commit

Permalink
docs: Internet #email, #domain do not control TLD (faker-ruby#1837)
Browse files Browse the repository at this point in the history
- The domain: keyword option passes in 'example' and gets
  'example.name' in the generated domain name
  - There is no current control over the top-level domain
  - This documentation change conveys that by using different
  top-level domains in the examples
  • Loading branch information
olleolleolle authored and michebble committed Feb 16, 2020
1 parent f2f5a10 commit 3ca46fb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/default/internet.md
Expand Up @@ -5,7 +5,7 @@
Faker::Internet.email #=> "eliza@mann.net"
Faker::Internet.email(name: 'Nancy') #=> "nancy@terry.biz"
Faker::Internet.email(name: 'Janelle Santiago', separators: '+') #=> janelle+santiago@becker.com"
Faker::Internet.email(domain: 'example.com') #=> alice@example.com"
Faker::Internet.email(domain: 'example') #=> alice@example.name"

# Keyword arguments: name
Faker::Internet.free_email #=> "freddy@gmail.com"
Expand Down Expand Up @@ -36,8 +36,8 @@ Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special

# Keyword arguments: subdomain, domain
Faker::Internet.domain_name #=> "effertz.info"
Faker::Internet.domain_name(domain: "example.com") #=> "example.com"
Faker::Internet.domain_name(subdomain: true, domain: "example.com") #=> "horse.example.com"
Faker::Internet.domain_name(domain: "example") #=> "example.net"
Faker::Internet.domain_name(subdomain: true, domain: "example") #=> "horse.example.org"

Faker::Internet.domain_word #=> "haleyziemann"

Expand Down

0 comments on commit 3ca46fb

Please sign in to comment.