Commits

Luke Plant committed 07112d8

Consistent language for documented replacers - 'generates' for compound data, 'returns' for simple values or selection from list

Comments (0)

Files changed (2)

anonymizer/replacers.py

 
 varchar = lambda anon, obj, field, val: anon.faker.varchar(field=field)
 varchar.__doc__ = """
-Produces random data for a varchar field.
+Returns random data for a varchar field.
 """
 
 bool = lambda anon, obj, field, val: anon.faker.bool(field=field)
 bool.__doc__ = """
-Produces a random boolean value (True/False)
+Returns a random boolean value (True/False)
 """
 
 integer = lambda anon, obj, field, val: anon.faker.integer(field=field)
 integer.__doc__ = """
-Produces a random integer (for a Django IntegerField)
+Returns a random integer (for a Django IntegerField)
 """
 
 positive_integer = lambda anon, obj, field, val: anon.faker.positive_integer(field=field)
 positive_integer.__doc__ = """
-Produces a random positive integer (for a Django PositiveIntegerField)
+Returns a random positive integer (for a Django PositiveIntegerField)
 """
 
 small_integer = lambda anon, obj, field, val: anon.faker.small_integer(field=field)
 small_integer.__doc__ = """
-Produces a random small integer (for a Django SmallIntegerField)
+Returns a random small integer (for a Django SmallIntegerField)
 """
 
 positive_small_integer = lambda anon, obj, field, val: anon.faker.positive_small_integer(field=field)
 positive_small_integer.__doc__ = """
-Produces a positive small random integer (for a Django PositiveSmallIntegerField)
+Returns a positive small random integer (for a Django PositiveSmallIntegerField)
 """
 
 datetime = lambda anon, obj, field, val: anon.faker.datetime(field=field)
 datetime.__doc__ = """
-Produces a random datetime
+Returns a random datetime
 """
 
 date = lambda anon, obj, field, val: anon.faker.date(field=field)
 date.__doc__ = """
-Produces a random date
+Returns a random date
 """
 
 uk_postcode = lambda anon, obj, field, val: anon.faker.uk_postcode(field=field)
 uk_postcode.__doc__ = """
-Produces a random UK postcode (not necessarily valid, but it will look like one).
+Generates a random UK postcode (not necessarily valid, but it will look like one).
 """
 
 uk_country = lambda anon, obj, field, val: anon.faker.uk_country(field=field)
 
 uk_county = lambda anon, obj, field, val: anon.faker.uk_county(field=field)
 uk_county.__doc__ = """
-Returns a random selected county from the UK
+Returns a randomly selected county from the UK
 """
 
 username = lambda anon, obj, field, val: anon.faker.username(field=field)
 username.__doc__ = """
-Produces a randomly generated username
+Generates a random username
 """
 
 first_name = lambda anon, obj, field, val: anon.faker.first_name(field=field)
 first_name.__doc__ = """
-Produces a randomly generated first name
+Returns a random first name
 """
 
 last_name = lambda anon, obj, field, val: anon.faker.last_name(field=field)
 last_name.__doc__ = """
-Produces a randomly generated second name
+Returns a random second name
 """
 
 name = lambda anon, obj, field, val: anon.faker.name(field=field)
 name.__doc__ = """
-Produces a randomly generated full name (using first name and last name)
+Generates a random full name (using first name and last name)
 """
 
 email = lambda anon, obj, field, val: anon.faker.email(field=field)
 email.__doc__ = """
-Produces a randomly generated email address.
+Generates a random email address.
 """
 full_address = lambda anon, obj, field, val: anon.faker.full_address(field=field)
 full_address.__doc__ = """
-Produces a randomly generated full address, using newline characters between the lines.
+Generates a random full address, using newline characters between the lines.
 Resembles a US address
 """
 phonenumber = lambda anon, obj, field, val: anon.faker.phonenumber(field=field)
 phonenumber.__doc__ = """
-Produces a randomly generated US-style phone number
+Generates a random US-style phone number
 """
 
 street_address = lambda anon, obj, field, val: anon.faker.street_address(field=field)
 street_address.__doc__ = """
-Produces a randomly generated street address - the first line of a full address
+Generates a random street address - the first line of a full address
 """
 
 city = lambda anon, obj, field, val: anon.faker.city(field=field)
 city.__doc__ = """
-Produces a randomly generated city name. Resembles the name of US/UK city.
+Generates a random city name. Resembles the name of US/UK city.
 """
 
 state = lambda anon, obj, field, val: anon.faker.state(field=field)
 
 company = lambda anon, obj, field, val: anon.faker.company(field=field)
 company.__doc__ = """
-Returns a randomly generated company name
+Generates a random company name
 """
 
 lorem = lambda anon, obj, field, val: anon.faker.lorem(field=field)
 lorem.__doc__ = """
-Returns a paragraph of lorem ipsum text
+Generates a paragraph of lorem ipsum text
 """
 
 similar_datetime = lambda anon, obj, field, val: anon.faker.datetime(field=field, val=val)
 
 similar_lorem = lambda anon, obj, field, val: anon.faker.lorem(field=field, val=val)
 similar_lorem.__doc__ = """
-Produces lorem ipsum text with the same length and same pattern of linebreaks as
-the original. If the original often takes a standard form (e.g. a single word
+Generates lorem ipsum text with the same length and same pattern of linebreaks
+as the original. If the original often takes a standard form (e.g. a single word
 'yes' or 'no'), this could easily fail to hide the original data.
 """
 

docs/djangofaker.rst

 
    .. method:: email(self, field=None, **kwargs)
 
-      Returns a randomly generated email address, using the pattern
+      Generates a random email address, using the pattern
       '<initial><last name>@<free email provider>'
 
    .. method:: username(self, field=None, **kwargs)
 
-      Returns a randomly generated user name, using the pattern
-      '<initial><lastname>'.
+      Generates a random user name, using the pattern '<initial><lastname>'.
 
    These name-related methods have the property that the same underlying first
    name and last name will be used until you repeat any of the methods. This
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.