Skip to content

Commit 23df5f5

Browse files
committed
[Docs] fix options formatting
1 parent 13fb572 commit 23df5f5

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

readme.markdown

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,15 @@ options are:
5959

6060
* opts.isFile - function to asynchronously test whether a file exists
6161

62-
* opts.packageFilter - transform the parsed package.json contents before looking
63-
at the "main" field
62+
* `opts.packageFilter(pkg, pkgfile)` - transform the parsed package.json contents before looking at the "main" field
6463

65-
* opts.pathFilter(pkg, path, relativePath) - transform a path within a package
64+
* `opts.pathFilter(pkg, path, relativePath)` - transform a path within a package
6665
* pkg - package data
6766
* path - the path being resolved
6867
* relativePath - the path relative from the package.json location
6968
* returns - a relative path that will be joined from the package.json location
7069

71-
* opts.paths - require.paths array to use if nothing is found on the normal
72-
node_modules recursive walk (probably don't use this)
70+
* opts.paths - require.paths array to use if nothing is found on the normal `node_modules` recursive walk (probably don't use this)
7371

7472
* opts.moduleDirectory - directory (or directories) in which to recursively look for modules. default: `"node_modules"`
7573

@@ -115,11 +113,9 @@ options are:
115113

116114
* opts.isFile - function to synchronously test whether a file exists
117115

118-
* `opts.packageFilter(pkg, pkgfile)` - transform the parsed package.json
119-
* contents before looking at the "main" field
116+
* `opts.packageFilter(pkg, pkgfile)` - transform the parsed package.json contents before looking at the "main" field
120117

121-
* opts.paths - require.paths array to use if nothing is found on the normal
122-
node_modules recursive walk (probably don't use this)
118+
* opts.paths - require.paths array to use if nothing is found on the normal `node_modules` recursive walk (probably don't use this)
123119

124120
* opts.moduleDirectory - directory (or directories) in which to recursively look for modules. default: `"node_modules"`
125121

0 commit comments

Comments
 (0)