Skip to content
This repository was archived by the owner on Mar 22, 2021. It is now read-only.

Commit ad5482c

Browse files
committed
Reduce pandoc-only Markdown syntax in README
This improves readability when viewing the README on GitHub.
1 parent 72a710a commit ad5482c

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ Change the working directory to the given path.
5454

5555
Parameters:
5656

57-
`directory`:
57+
`directory`
5858
: Path of the directory which is to become the new working directory.
5959

6060

61-
### env {#system-env}
61+
### env
6262

6363
`env ()`
6464

@@ -69,6 +69,7 @@ Returns:
6969
- A table mapping environment variables names to their string value
7070
(table).
7171

72+
### getenv
7273

7374
`getenv (var)`
7475

@@ -77,7 +78,7 @@ is no such value.
7778

7879
Parameters:
7980

80-
`var`:
81+
`var`
8182
: name of the environment variable (string)
8283

8384
Returns:
@@ -103,7 +104,7 @@ List the contents of a directory.
103104

104105
Parameters:
105106

106-
`directory`:
107+
`directory`
107108
: Path of the directory whose contents should be listed (string).
108109
Defaults to `.`.
109110

@@ -128,10 +129,10 @@ necessary.
128129

129130
Parameters:
130131

131-
`dirname`:
132+
`dirname`
132133
: name of the new directory
133134

134-
`create_parent`:
135+
`create_parent`
135136
: create parent directories if necessary
136137

137138
### rmdir
@@ -143,27 +144,27 @@ then delete the directory and its contents recursively.
143144

144145
Parameters:
145146

146-
`dirname`:
147+
`dirname`
147148
: name of the directory to delete
148149

149-
`recursive`:
150+
`recursive`
150151
: delete content recursively
151152

152-
### setenv {#system-setenv}
153+
### setenv
153154

154155
`setenv (var, value)`
155156

156157
Set the specified environment variable to a new value.
157158

158159
Parameters:
159160

160-
`var`:
161+
`var`
161162
: name of the environment variable (string).
162163

163-
`value`:
164+
`value`
164165
: new value (string).
165166

166-
### tmpdirname {#system-tmpdirname}
167+
### tmpdirname
167168

168169
`tmpdirname ()`
169170

@@ -200,20 +201,20 @@ action.
200201

201202
Parameters:
202203

203-
`environment`:
204+
`environment`
204205
: Environment variables and their values to be set before
205206
running `callback`. (table with string keys and string
206207
values)
207208

208-
`callback`:
209+
`callback`
209210
: Action to execute in the custom environment (function)
210211

211212
Returns:
212213

213214
- The result(s) of the call to `callback`
214215

215216

216-
### with\_tmpdir {#system-with_tmpdir}
217+
### with\_tmpdir
217218

218219
`with_tmpdir ([parent_dir,] templ, callback)`
219220

@@ -222,15 +223,15 @@ The directory is deleted after use.
222223

223224
Parameters:
224225

225-
`parent_dir`:
226+
`parent_dir`
226227
: Parent directory to create the directory in (string). If this
227228
parameter is omitted, the system's canonical temporary directory is
228229
used.
229230

230-
`templ`:
231+
`templ`
231232
: Directory name template (string).
232233

233-
`callback`:
234+
`callback`
234235
: Function which takes the name of the temporary directory as its
235236
first argument (function).
236237

0 commit comments

Comments
 (0)