Skip to content

Commit 9c65e5d

Browse files
committed
fix spelling & formatting mistakes
1 parent 81f1adf commit 9c65e5d

File tree

7 files changed

+6149
-6141
lines changed

7 files changed

+6149
-6141
lines changed

build/src/docs.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
## Usage
1717

1818
### Browser
19+
1920
```html
2021
<script src = "faker.js" type = "text/javascript"></script>
2122
<script>
@@ -24,14 +25,17 @@
2425
var randomCard = faker.helpers.createCard(); // random contact card containing many properties
2526
</script>
2627
```
28+
2729
### Node.js
30+
2831
```js
2932
var faker = require('faker');
3033

3134
var randomName = faker.name.findName(); // Rowan Nikolaus
3235
var randomEmail = faker.internet.email(); // [email protected]
3336
var randomCard = faker.helpers.createCard(); // random contact card containing many properties
3437
```
38+
3539
## API
3640

3741
### JSDoc API Browser
@@ -49,10 +53,12 @@ faker.js contains a super useful generator method `Faker.fake` for combining fak
4953
**Example:**
5054

5155
{{=<% %>=}}
56+
5257
``` js
5358
console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}"));
5459
// outputs: "Marks, Dean Sr."
5560
```
61+
5662
<%={{ }}=%>
5763

5864
This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()`
@@ -104,42 +110,44 @@ console.log(firstRandom === secondRandom);
104110

105111
## Tests
106112

107-
npm install .
108-
make test
113+
```shell
114+
npm install .
115+
make test
116+
```
109117

110118
You can view a code coverage report generated in coverage/lcov-report/index.html.
111119

112120
## Building faker.js
113121

114-
faker uses [gulp](http://gulpjs.com/) to automate it's build process. Each build operation is a separate task which can be run independently.
122+
faker uses [gulp](http://gulpjs.com/) to automate its build process. Each build operation is a separate task which can be run independently.
115123

116124
### Browser Bundle
117125

118-
```
126+
```shell
119127
npm run browser
120128
```
121129

122130
### Building JSDocs
123131

124132
[JSDOC](https://jsdoc.app/) v3 HTML API documentation
125133

126-
```
134+
```shell
127135
npm run jsdoc
128136
```
129137

130138
### Building ReadMe
131139

132-
The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updateds to `ReadMe.md` should be perfomed in `./build/src/docs.md` and then the build script should be run.
140+
The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updates to `ReadMe.md` should be performed in `./build/src/docs.md` and then the build script should be run.
133141

134-
```
142+
```shell
135143
npm run readme
136144
```
137145

138146
## Version Release Schedule
139147

140148
faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible.
141149

142-
If you require the absolute latest version of `faker.js` the `master` branch @ http://github.com/marak/faker.js/ should always be up to date and working.
150+
If you require the absolute latest version of `faker.js` the `master` branch @ <http://github.com/marak/faker.js/> should always be up to date and working.
143151

144152
## Maintainer
145153

@@ -152,8 +160,8 @@ http://github.com/marak/faker.js/
152160

153161
faker.js was inspired by and has used data definitions from:
154162

155-
* https://github.com/stympy/faker/ - Copyright (c) 2007-2010 Benjamin Curtis
156-
* http://search.cpan.org/~jasonk/Data-Faker-0.07/ - Copyright 2004-2005 by Jason Kohles
163+
* <https://github.com/stympy/faker/> - Copyright (c) 2007-2010 Benjamin Curtis
164+
* <http://search.cpan.org/~jasonk/Data-Faker-0.07/> - Copyright 2004-2005 by Jason Kohles
157165

158166
Permission is hereby granted, free of charge, to any person obtaining
159167
a copy of this software and associated documentation files (the

0 commit comments

Comments
 (0)