Skip to content

Commit 23e1221

Browse files
christineroseshonfeder
authored andcommitted
doc: capitalize headers and tweak formatting
Signed-off-by: Shon Feder <[email protected]>
1 parent 04b6a9f commit 23e1221

File tree

2 files changed

+29
-29
lines changed

2 files changed

+29
-29
lines changed

doc/usage.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ the file and directory, if necessary):
7474
(preprocess
7575
(pps ppx_inline_tests)))
7676
77-
Initializing components in a specified directory
77+
Initializing Components in a Specified Directory
7878
------------------------------------------------
7979

8080
All ``init`` subcommands take an optional ``PATH`` argument, which should be a
@@ -94,7 +94,7 @@ To initialize a project in a directory in some nested path, run
9494
9595
If the specified directory does not already exist, it will be created.
9696

97-
Learning more about the ``init`` commands
97+
Learning More About the ``init`` Commands
9898
-----------------------------------------
9999

100100
Consult the manual page using the ```dune init --help`` command for more
@@ -330,8 +330,8 @@ must be prefixed by the shortest one.
330330

331331
.. _dune-subst:
332332

333-
dune subst
334-
==========
333+
``dune subst``
334+
==============
335335

336336
One of the features ``dune-release`` provides is watermarking; it replaces
337337
various strings of the form ``%%ID%%`` in all your project files

test/blackbox-tests/test-cases/dune-init.t/run.t

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Setup mutable files
99
> (name test_lib))
1010
> EOF
1111

12-
Adding a library
12+
Adding a Library
1313
----------------
1414

1515
Can init a public library
@@ -61,7 +61,7 @@ Clean up library with inlines tests
6161

6262
$ rm -rf ./_inline_tests_lib
6363

64-
Adding an executable
64+
Adding an Executable
6565
--------------------
6666

6767
Can init a public executable
@@ -90,7 +90,7 @@ Clean up the executable tests
9090

9191
$ rm -rf ./_test_bin_dir
9292

93-
Adding tests
93+
Adding Tests
9494
------------
9595

9696
Can init tests
@@ -109,7 +109,7 @@ Clean up the test tests
109109

110110
$ rm -rf ./_test_tests_dir
111111

112-
Adding components to default and non-standard places
112+
Adding Components to Default and Non-Standard Places
113113
---------------------------------------------------
114114

115115
Add a library in the current working directory
@@ -124,23 +124,23 @@ Clean the library creation
124124

125125
$ rm ./dune
126126

127-
Add a library to a dune file in a specified directory
127+
Add a library to a `dune` file in a specified directory
128128

129129
$ dune init lib test_lib ./_test_dir
130130
Success: initialized library component named test_lib
131131
$ test -f ./_test_dir/dune
132132

133-
Clean up from the dune file created in ./_test_dir
133+
Clean up from the `dune` file created in ./_test_dir
134134

135135
$ rm -rf ./_test_dir
136136

137-
Add a library to a dune file in a directory specified with an absolute path
137+
Add a library to a `dune` file in a directory specified with an absolute path
138138

139139
$ dune init lib test_lib $PWD/_test_dir
140140
Success: initialized library component named test_lib
141141
$ test -f $PWD/_test_dir/dune
142142

143-
Clean up from the dune file created at an absolute path
143+
Clean up from the `dune` file created at an absolute path
144144

145145
$ rm -rf $PWD/_test_dir
146146

@@ -150,11 +150,11 @@ Add a library in the current working directory
150150
Success: initialized library component named test_cwd_lib
151151
$ test -f dune
152152

153-
Clean up from the dune file created in the current workding dir
153+
Clean up from the `dune` file created in the current workding dir
154154

155155
$ rm dune
156156

157-
Adding a library and an executable dependent on that library
157+
Adding a Library and an Executable Dependent on that Library
158158
------------------------------------------------------------
159159

160160
Can init a library and dependent executable in a combo project
@@ -185,7 +185,7 @@ Clean up the combo project
185185

186186
$ rm -rf ./_test_lib_exe_dir
187187

188-
Adding libraries in a single directory
188+
Adding Libraries in a Single Directory
189189
--------------------------------------
190190

191191
Can add multiple libraries in the same directory
@@ -214,7 +214,7 @@ Clan up the multiple library project
214214

215215
$ rm -rf ./_test_lib
216216

217-
Multiple ppxs and library dependencies
217+
Multiple PPXs and Library Dependencies
218218
--------------------------------------
219219

220220
Can add multiple library dependencies in one command
@@ -244,7 +244,7 @@ Will not overwrite existing files
244244
$ cat ./existing_project/bin/main.ml
245245
() = print_endline "Goodbye"
246246

247-
Comments in dune files are preserved
247+
Comments in `dune` files are preserved
248248

249249
$ dune init lib test_lib2 ./existing_project/src
250250
Success: initialized library component named test_lib2
@@ -271,7 +271,7 @@ Will not create components with invalid names
271271
$ test -f ./_test_lib
272272
[1]
273273

274-
Adding fields to existing stanzas
274+
Adding Fields to Existing Stanzas
275275
---------------------------------
276276

277277
# TODO(shonfeder)
@@ -294,10 +294,10 @@ Adding fields to existing stanzas is currently not supported
294294
(name test_bin)
295295
(libraries test_lib1))
296296

297-
Creating projects
297+
Creating Projects
298298
-----------------
299299

300-
Initializing executable projects
300+
Initializing Executable Projects
301301
================================
302302

303303
We can init a new executable project:
@@ -307,7 +307,7 @@ We can init a new executable project:
307307
Success: initialized project component named new_exec_proj
308308
Leaving directory 'new_exec_proj'
309309

310-
The generated project contains all expected sub-components:
310+
The generated project contains all expected subcomponents:
311311

312312
$ ls new_exec_proj/**
313313
new_exec_proj/dune-project
@@ -327,7 +327,7 @@ The generated project contains all expected sub-components:
327327
dune
328328
test_new_exec_proj.ml
329329

330-
In particular, the dune-project file has the expected content:
330+
In particular, the `dune-project` file has the expected content:
331331

332332
$ cat new_exec_proj/dune-project | sed 's/dune [0-9].[0-9]*/dune $version/g'
333333
(lang dune $version)
@@ -411,7 +411,7 @@ We can build and run the project's tests:
411411
Entering directory 'new_exec_proj'
412412
Leaving directory 'new_exec_proj'
413413

414-
Initializing library projects
414+
Initializing Library Projects
415415
================================
416416

417417
We can init a new library project:
@@ -421,7 +421,7 @@ We can init a new library project:
421421
Success: initialized project component named new_lib_proj
422422
Leaving directory 'new_lib_proj'
423423

424-
The generated project contains all expected sub-components:
424+
The generated project contains all expected subcomponents:
425425

426426
$ ls new_lib_proj/**
427427
new_lib_proj/dune-project
@@ -437,7 +437,7 @@ The generated project contains all expected sub-components:
437437
dune
438438
test_new_lib_proj.ml
439439

440-
In particular, the dune-project file has the expected content:
440+
In particular, the `dune-project` file has the expected content:
441441

442442
$ cat new_lib_proj/dune-project | sed 's/dune [0-9].[0-9]*/dune $version/g'
443443
(lang dune $version)
@@ -519,7 +519,7 @@ And we we can run the tests:
519519
Leaving directory 'new_lib_proj'
520520

521521

522-
Initializing projects using the PATH argument
522+
Initializing Projects Using the PATH Argument
523523
=============================================
524524

525525
We can init a project in a specified directory:
@@ -539,7 +539,7 @@ https://github.com/ocaml/dune/issues/9209):
539539
Success: initialized project component named project_in_cwd
540540
$ test -f dune-project
541541

542-
Initializing projects using Esy
542+
Initializing Projects Using Esy
543543
===============================
544544

545545
We can init a project using Esy:
@@ -549,7 +549,7 @@ We can init a project using Esy:
549549
Success: initialized project component named new_esy_proj
550550
Leaving directory 'new_esy_proj'
551551

552-
The esy project contains all expected sub-components:
552+
The `esy` project contains all expected subcomponents:
553553

554554
$ ls new_esy_proj/**
555555
new_esy_proj/dune-project
@@ -569,7 +569,7 @@ The esy project contains all expected sub-components:
569569
dune
570570
test_new_esy_proj.ml
571571

572-
And the dune-project file does NOT specify generation of an opam file:
572+
And the `dune-project` file does NOT specify generation of an opam file:
573573

574574
$ cat new_esy_proj/dune-project | grep "generate_opam_files"
575575
(generate_opam_files false)

0 commit comments

Comments
 (0)