Explain safe_email method (faker-ruby#1833)

michebble · Feb 16, 2020 · bd6d58a · bd6d58a
1 parent 12a5957
commit bd6d58a
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/doc/default/internet.md b/doc/default/internet.md
@@ -11,6 +11,7 @@ Faker::Internet.email(domain: 'example.com') #=> alice@example.com"
 Faker::Internet.free_email #=> "freddy@gmail.com"
 Faker::Internet.free_email(name: 'Nancy') #=> "nancy@yahoo.com"
 
+# Generates an RFC 2606 compliant fake email, which means it will never deliver successfully
 # Keyword arguments: name
 Faker::Internet.safe_email #=> "christelle@example.org"
 Faker::Internet.safe_email(name: 'Nancy') #=> "nancy@example.net"