Fix typo in docstring of date (#1654)

* Fix typo in docstring of date * Update __init__.py Co-authored-by: Flavio Curella <89607+fcurella@users.noreply.github.com>
joke2k · May 9, 2022 · 8da372e · 8da372e
1 parent 01f4b15
commit 8da372e
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/faker/providers/date_time/__init__.py b/faker/providers/date_time/__init__.py
@@ -1886,9 +1886,11 @@ def iso8601(
 
     def date(self, pattern: str = "%Y-%m-%d", end_datetime: Optional[DateParseType] = None) -> str:
         """
-        Get a date string between January 1, 1970 and now
-        :param pattern: format
+        Get a date string between January 1, 1970 and now.
+
+        :param pattern: Format of the date (year-month-day by default)
         :example: '2008-11-27'
+        :return: Date
         """
         return self.date_time(end_datetime=end_datetime).strftime(pattern)