Skip to content
This repository was archived by the owner on May 1, 2020. It is now read-only.

Commit 785bcda

Browse files
committed
Update documentation for new options
1 parent 27f503d commit 785bcda

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Toggles `--no-prefix` that does not include the comment header.
9090

9191
###### `ffi` (String Array)
9292

93-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
93+
Sets one or more `--ffi=<string>` that specifies the files for code that is included with a `foreign import` in the PureScript source.
9494

9595
### `purescript.pscMake(options)`
9696

@@ -130,7 +130,7 @@ Toggles `--no-prefix` that does not include the comment header.
130130

131131
###### `ffi` (String Array)
132132

133-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
133+
Sets one or more `--ffi=<string>` that specifies files for code that is included with a `foreign import` in the PureScript source.
134134

135135
### `purescript.pscDocs(options)`
136136

@@ -140,6 +140,14 @@ Invokes the `pscDocs` command. The following options are supported.
140140

141141
Sets `--output=<markdown|etags|ctags>` that specifies the output format.
142142

143+
###### `docgen` (String | String Array | Object)
144+
145+
Sets `--docgen=...` that can be used to filter the modules documentation is generated for.
146+
147+
- If a string value is provided, the documentation for that single module will be generated.
148+
- If a list of strings is provided, the documentation for all listed modules will be generated.
149+
- If an object with module name/filename pairs (for example, `{ Module: "docs/Module.md" }`) is provided, files will be written for each of the modules. In this mode, the task requires no `dest` as no value is returned.
150+
143151
### `purescript.dotPsci()`
144152

145153
Generates a `.psci` file in the current directory. Each source file is added with the `:m` command.

0 commit comments

Comments
 (0)