Improve documentation of return values #1599
Labels
c: docs
Improvements or additions to documentation
m: date
Something is referring to the date module
p: 1-normal
Nothing urgent
wontfix
This will not be worked on
Milestone
As a user it was not instantly clear to me that the return value of a method like
faker.date.past()
returns aDate
and not astring
by just reading the docs@example
tag.Proposal:
Change return value comments
Reason: This is actually executable and will indicate clearly that is not just a string
Also change the description to mention
{@link Date} instance
Attention: We need to update also our documentation generator scripts
The text was updated successfully, but these errors were encountered: