Skip to content

Commit dd5cbd3

Browse files
christinerosepanglesd
authored andcommitted
make "hardcode" consistent
1 parent 3ee58d9 commit dd5cbd3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/driver.mld

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Once the compile and link phases are complete, the resulting [odocl] files may b
125125
{1 [odoc] Documentation}
126126

127127
In this section [odoc] is used to generate the documentation of [odoc] and some of its dependent packages. We can make a few simplifying assumptions here:
128-
{ol {- Since we're working with one leaf package, we can assume that there can be no module name clashes in the dependencies. As such, we can afford to put all of our [.odoc] files into one directory and then hard-code the include path to be this directory. When using [odoc] in a context where there may be module name clashes, it requires more careful partitioning of output directories.
128+
{ol {- Since we're working with one leaf package, we can assume that there can be no module name clashes in the dependencies. As such, we can afford to put all of our [.odoc] files into one directory and then hardcode the include path to be this directory. When using [odoc] in a context where there may be module name clashes, it requires more careful partitioning of output directories.
129129
}{- We'll do all of the compiling before any linking.
130130
}}
131131

@@ -143,10 +143,10 @@ identifiers. The [compile-src] command takes a source-tree parent file and a
143143
source path that has to be in the source tree.
144144

145145
Linking a file with [odoc] requires the input file and a list of include paths. As
146-
for compile, we will hard-code the include path.
146+
for compile, we will hardcode the include path.
147147

148148
Generating the HTML requires the input [odocl] file and an output path. We will
149-
hard-code the output path to be [html/]. In the case of implementations, a
149+
hardcode the output path to be [html/]. In the case of implementations, a
150150
source file (passed via the [--source] argument) is required.
151151

152152
To get the number of uses of each identifier, we can use the [count-occurrences]
@@ -313,7 +313,7 @@ We'll now make some library lists. We have not only external dependency
313313
libraries, but [odoc] itself is also separated into libraries. These two
314314
sets of libraries will be documented in different sections, so we'll keep them
315315
in separate lists. Moreover, [odoc] libraries will include the source code via
316-
a hard-coded path.
316+
a hardcoded path.
317317

318318
Additionally, we'll construct a list containing the extra documentation pages. Finally let's create a list mapping the section to its parent, which matches
319319
the hierarchy declared above.

0 commit comments

Comments
 (0)