Mark and visualize aliases for the api-docs #1183
Labels
c: docs
Improvements or additions to documentation
c: feature
Request for new feature
p: 1-normal
Nothing urgent
s: waiting for user interest
Waiting for more users interested in this feature
Milestone
Clear and concise description of the problem
Methods should refer to related methods to improve visibility for developers, so they can find replacement/alternative methods more easily.
E.g. The developers searches for an android app package name. The developer finds the hacker module with the
appleBundleId
, then sees that it is an alias and now finds theinternet.domainName
method that they use until they PR their new method here.There might also be value in the reverse alias.
E.g. the developer wants and appleBundleId, but searches for reverse domain names and thus stumples across the
internet.domainName
method and there they discover that the method they need exist already.Suggested solution
Use jsdocs
@alias
to refer to the core of an implementation.E.g.
However there are some things that needs to be defined, before we can add this.
faker.datatype.number()
andfaker.datatype.boolean()
)faker.random.arrayElement()
)faker.internet.domainName(params)
faker.internet.domainName
faker.internet.domainName(reverse: true)
e.g.
faker.internet.domainName
<->faker.hacker.appleBundleId
@see
? (Above or below or mixed with@see
?)Alternative
@see
to link these methods togetherAdditional context
The issue originally came up during #1154 .
The text was updated successfully, but these errors were encountered: