Skip to content

Commit

Permalink
README: typos
Browse files Browse the repository at this point in the history
  • Loading branch information
AltGr committed Feb 7, 2013
1 parent 51e4773 commit f429032
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
22 changes: 11 additions & 11 deletions README.md
Expand Up @@ -32,10 +32,9 @@ If you use opam and want it installed alongside ocaml, you may want to use

## Usage

The previous installation step will copy elisp and vim scripts to
The above installation step copies elisp and vim scripts to
`<prefix>/share/typerex/ocp-indent/`. You then need to load them in
the editor of your choice to automatically use ocp-indent (obviously,
replacing `<prefix>`).
the editor of your choice to automatically use ocp-indent.

### Emacs

Expand All @@ -50,18 +49,18 @@ echo '(load-file "$(opam config var prefix)/share/typerex/ocp-indent/ocp-indent.
Use the following command to tell Vim to use `ocp-indent`:

```bash
echo 'autocmd FileType ocaml source $(opam config vas)/share/typerex/ocp-indent/ocp-indent.vim' >>~/.vimrc
echo 'autocmd FileType ocaml source $(opam config var prefix)/share/typerex/ocp-indent/ocp-indent.vim' >>~/.vimrc
```

### Other editors

As `ocp-indent` is a command-line tool, you can easily integrate it with other editors.
As `ocp-indent` is a command-line tool, you can easily integrate it with other editors.

```bash
ocp-indent <src-file> > <dst-file>
```

You can also tell him to indent only a subsets of lines, and to output only the indentation level:
You can also tell it to indent only a subsets of lines, and to output only the indentation level:

```bash
ocp-indent <src-file> --lines <l1>-<l2> --numeric
Expand All @@ -71,11 +70,11 @@ ocp-indent <src-file> --lines <l1>-<l2> --numeric

We've run some benchmarks on real code-bases and the result is quite
conclusive. Keep in mind than most of existing source files are
already indented manually or followed either tuareg standards. You can
either indented manually or following tuareg standards. You can
see the results [here](http://htmlpreview.github.com/?https://github.com/AltGr/ocp-indent-tests/blob/master/status.html).

Moreover, as `ocp-indent` has a deep understanding of the OCaml syntax
it can shines on specific cases. See for instances the collection of
it shines on specific cases. See for instance the collection of
unit-tests
[here](https://github.com/OCamlPro/ocp-indent/tree/master/tests/passing). The
currently failing tests can be seen
Expand All @@ -87,8 +86,8 @@ this).
## Testing

It's hard to deliver a great indenter without tests. We've built
`ocp-indent` based a growing collection of unit-tests. If you find an
indentation bug, fill free to send us a code snippet that we will
`ocp-indent` based on a growing collection of unit-tests. If you find an
indentation bug, feel free to send us a code snippet that we will
incorporate into our test suite.

The tests are organized as follows:
Expand All @@ -97,7 +96,8 @@ The tests are organized as follows:
unchanged by ocp-indent.
* `tests/failing` contains tests for which ocp-indent currently returns the
results in `tests/failing-output`, hence `meld tests/failing{,-output}` should
give an overview of currently known bugs.
give an overview of currently known bugs (also available online
[here](http://htmlpreview.github.com/?https://github.com/OCamlPro/ocp-indent/blob/master/tests/failing.html)).
* `tests/test.sh` checks the current state against the reference state (checked
into git).
* `tests/test.sh --[git-]update` updates the current reference state.
Expand Down
18 changes: 9 additions & 9 deletions tests/failing.html
Expand Up @@ -2,7 +2,7 @@
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
<title>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</title>
<title>Failing tests, ocp-indent version 0.6.2+9 (2013-02-07)</title>
<style>
BODY { font-family: monospace; }
TABLE { border-collapse: collapse; border-spacing: 0px; margin: auto; }
Expand All @@ -22,7 +22,7 @@
</style>
</head>
<body>
<h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
<h1>Failing tests, ocp-indent version 0.6.2+9 (2013-02-07)</h1>
<p>Left is expected result, right shows actual indentation by ocp-indent</p>
<table>
<tr><td width="70%">
Expand Down Expand Up @@ -209,7 +209,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:12</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:09:50</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -808,7 +808,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:14</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:09:52</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -1015,7 +1015,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:16</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:09:53</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -1159,7 +1159,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:17</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:09:54</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -2094,7 +2094,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:20</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:09:58</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -2882,7 +2882,7 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:22</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:10:00</i>
<table>
<tr><td width="70%">
<table>
Expand Down Expand Up @@ -3747,6 +3747,6 @@ <h1>Failing tests, ocp-indent version 0.6.1+28 (2013-02-07)</h1>
</tr>
</table>
<hr/>
<i>Generated by <b>diff2html</b> on 2013-02-07 10:42:25</i>
<i>Generated by <b>diff2html</b> on 2013-02-07 11:10:03</i>
</body>
</html>

0 comments on commit f429032

Please sign in to comment.