Skip to content

Commit db9bb9e

Browse files
authored
Merge pull request #1332 from herbie-fp/cleanup-docs
Document representations and generators
2 parents bfbdde1 + 1e06cd1 commit db9bb9e

File tree

3 files changed

+129
-420
lines changed

3 files changed

+129
-420
lines changed

www/doc.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ <h2>Documentation</h2>
3737
<li><a href="doc/latest/options.html">Command-line flags</a>: modifying Herbie's behavior.</li>
3838
<li><a href="doc/latest/error.html">What is error?</a>: how Herbie measures floating-point error.</li>
3939
<li><a href="doc/latest/faq.html">Warnings and Errors</a>: troubleshooting Herbie.</li>
40-
<li><a href="doc/latest/platforms.html">Platforms</a>: how to write a new Herbie compilation target.</li>
4140
<li><a href="doc/latest/release-notes.html">Release Notes</a>: the biggest and latest changes to Herbie.</li>
4241
</ul>
4342

44-
<h2>Internal Documentation</h2>
43+
<h2>Developer Documentation</h2>
4544
<ul>
46-
<li><a href="doc/latest/plugins.html">Plugins</a>: teaching Herbie about new input formats.</li>
45+
<li><a href="doc/latest/platforms.html">Platforms</a>: how to write a new Herbie compilation target.</li>
46+
<li><a href="doc/latest/plugins.html">Other APIs</a>: advanced APIs for compilation targets.</li>
4747
<li><a href="doc/latest/api-endpoints.html">HTTP API</a>: Herbie's HTTP endpoints</li>
4848
<li><a href="doc/latest/diagrams.html">Diagrams</a>: miscellaneous figures related to Herbie</li>
4949
</ul>

www/doc/2.2/platforms.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ <h2>Platform Concepts</h2>
4545
reprentations of <code>real</code> and correspond to single- and
4646
double-precision IEEE-754 arithmetic. There's also
4747
a <code>&lt;bool&gt;</code> representation for booleans. It's
48-
possible to define new representations, but that's out of scope for
49-
this page.</p>
48+
possible to define new representations, described
49+
on <a href="plugins.html">another page</a>.</p>
5050

5151
<p><dfn>Operations</dfn> are the floating-point analog of functions
5252
and represent the actual floating-point operation the compilation

0 commit comments

Comments
 (0)