diff options
| author | Matt Mayer <[email protected]> | 2023-03-29 20:36:46 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-29 13:36:46 +0000 |
| commit | 3562e872530b3610d95be71aa6f4f7fdfef7134f (patch) | |
| tree | c6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/science | |
| parent | 88e561a5490003a41665eb007c5c28ff0800ae09 (diff) | |
| download | faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip | |
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/science')
| -rw-r--r-- | src/modules/science/index.ts | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/modules/science/index.ts b/src/modules/science/index.ts index 754bcbdf..ef85f299 100644 --- a/src/modules/science/index.ts +++ b/src/modules/science/index.ts @@ -31,6 +31,10 @@ export interface Unit { /** * Module to generate science related entries. + * + * ### Overview + * + * Both methods in this module return objects rather than strings. For example, you can use `faker.science.chemicalElement().name` to pick out the specific property you need. */ export class ScienceModule { constructor(private readonly faker: Faker) { |