Skip to content

Commit cfb2296

Browse files
kgrytekgryte
committed
Fix lint errors
1 parent 81806f5 commit cfb2296

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

‎tools/make/README.md‎

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Makefile
22
===
3+
34
> Development utility.
45
56
This project uses [`make`][make] as its development utility. For an overview of `make`, see the `make` [manual][make].
@@ -16,6 +17,7 @@ $ make help
1617
```
1718

1819
===
20+
1921
#### Notes
2022

2123
Annotating source code is a useful means for inlining action items and notes. For example,
@@ -37,14 +39,16 @@ $ make notes
3739
```
3840

3941
The following annotations are recognized:
40-
* __TODO__: annotates a future task.
41-
* __FIXME__: annotates a problem.
42-
* __HACK__: annotates fragile/non-general solutions.
43-
* __WARNING__: annotates possible pitfalls or gotchas.
44-
* __OPTIMIZE__: annotates code which needs optimizing.
45-
* __NOTE__: annotates questions, comments, or anything which does not fit under `TODO`/`FIXME`/`HACK`/`WARNING`/`OPTIMIZE` and should be brought to a reader's attention.
42+
43+
* __TODO__: annotates a future task.
44+
* __FIXME__: annotates a problem.
45+
* __HACK__: annotates fragile/non-general solutions.
46+
* __WARNING__: annotates possible pitfalls or gotchas.
47+
* __OPTIMIZE__: annotates code which needs optimizing.
48+
* __NOTE__: annotates questions, comments, or anything which does not fit under `TODO`/`FIXME`/`HACK`/`WARNING`/`OPTIMIZE` and should be brought to a reader's attention.
4649

4750
===
51+
4852
#### Files
4953

5054
The `Makefile` exposes several targets (also used internally) for finding project files. For example, to list all project files, excluding `node_modules`, `build`, `reports`, and hidden directories,
@@ -69,8 +73,9 @@ $ make FILES_FILTER=.*/utils/is-nan/.* list-files
6973

7074
__Notes__:
7175

72-
* Most filters should begin with `.*/` and end with `/.*`, as a filter is used as a regular expression to test a file path.
73-
* The `*_PATTERN` and `*_FILTER` environment variables map to `-name` and `-regex` options, respectively, for the `find` command. For certain types of operations, like regular expressions using `|` for alternative matches, you may need to use `*_FILTER` over `*_PATTERN`. For instance,
76+
* Most filters should begin with `.*/` and end with `/.*`, as a filter is used as a regular expression to test a file path.
77+
78+
* The `*_PATTERN` and `*_FILTER` environment variables map to `-name` and `-regex` options, respectively, for the `find` command. For certain types of operations, like regular expressions using `|` for alternative matches, you may need to use `*_FILTER` over `*_PATTERN`. For instance,
7479

7580
``` bash
7681
# List all `R` test fixtures...
@@ -80,7 +85,6 @@ __Notes__:
8085
$ make TESTS_FIXTURES_FILTER='.*/*\.(jl|R)' list-test-fixtures
8186
```
8287

83-
8488
The `Makefile` includes the following common recipes for listing different file types...
8589

8690

@@ -106,7 +110,6 @@ To filter based on a file path,
106110
$ make SOURCES_FILTER=.*/math/.* list-sources
107111
```
108112

109-
110113
##### Tests
111114

112115
To list all test files,
@@ -129,7 +132,6 @@ To filter based on a file path,
129132
$ make TESTS_FILTER=.*/utils/fs/.* list-tests
130133
```
131134

132-
133135
##### Test Fixtures
134136

135137
To list all test fixture files,
@@ -152,7 +154,6 @@ To filter based on a file path,
152154
$ make TESTS_FIXTURES_FILTER=.*/math/special/.* list-test-fixtures
153155
```
154156

155-
156157
##### Examples
157158

158159
To list all examples files,
@@ -175,9 +176,9 @@ To filter based on a file path,
175176
$ make EXAMPLES_FILTER=.*/math/base/special/.* list-examples
176177
```
177178

178-
179179
===
180-
#### Examples
180+
181+
#### Module Examples
181182

182183
To run module examples,
183184

@@ -192,8 +193,8 @@ To limit which examples are run, use the same environment variables recognized b
192193
$ make EXAMPLES_FILTER=.*/math/base/special/.* EXAMPLES_PATTERN=index.js examples
193194
```
194195

195-
196196
===
197+
197198
#### Unit Tests
198199

199200
To run unit tests,
@@ -218,7 +219,6 @@ $ make TESTS_FILTER=.*/math/base/utils/.* TESTS_PATTERN=test.js test
218219
$ make TESTS_FILTER=.*/math/base/blas/.* test-summary
219220
```
220221

221-
222222
#### Test Coverage
223223

224224
To generate a test coverage report,
@@ -240,7 +240,6 @@ To view a generated report in a local web browser,
240240
$ make view-cov
241241
```
242242

243-
244243
#### Browser Tests
245244

246245
To run browser tests in a (headless) local web browser,
@@ -265,8 +264,8 @@ $ make TESTS_FILTER=.*/math/base/utils/.* test-browsers
265264
$ make TESTS_FILTER=.*/\@stdlib/utils/.* test-view-browsers
266265
```
267266

268-
269267
===
268+
270269
#### Documentation
271270

272271
To generate documentation from [JSDoc][jsdoc] source code comments,
@@ -281,9 +280,8 @@ To view the documentation in a local web browser,
281280
$ make view-src-docs
282281
```
283282

284-
285-
286283
===
284+
287285
#### Lint
288286

289287
To lint all source code, including tests and examples,
@@ -310,8 +308,6 @@ To lint only example files,
310308
$ make EXAMPLES_FILTER=... lint-examples
311309
```
312310

313-
314-
315311
<!-- <links> -->
316312
[make]: https://www.gnu.org/software/make/manual/make.html#Introduction
317313
[jsdoc]: http://usejsdoc.org/

0 commit comments

Comments
 (0)