Skip to content

Commit 6c2e010

Browse files
committed
Update docs
1 parent 0de7e87 commit 6c2e010

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/index.html

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
66
<meta name="generator" content="pdoc3 0.11.5">
77
<title>better_functools API documentation</title>
8-
<meta name="description" content="More functools improves functional programming ergonomics in Python …">
8+
<meta name="description" content="Better functools improves functional programming ergonomics in Python …">
99
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
1010
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
1111
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
@@ -36,7 +36,11 @@
3636
<h1 class="title">Package <code>better_functools</code></h1>
3737
</header>
3838
<section id="section-intro">
39-
<p>More functools improves functional programming ergonomics in Python</p>
39+
<p>Better functools improves functional programming ergonomics in Python</p>
40+
<h2 id="installation">Installation</h2>
41+
<pre><code>$ pip install better-functools
42+
</code></pre>
43+
<h2 id="background">Background</h2>
4044
<p>The library introduces 2 different operators for use with functions:
4145
- <code>|</code> which we'll call "pipe"
4246
- <code>@</code> which we'll call "apply"</p>
@@ -118,9 +122,13 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
118122
<nav id="sidebar">
119123
<div class="toc">
120124
<ul>
125+
<li><a href="#installation">Installation</a></li>
126+
<li><a href="#background">Background</a><ul>
121127
<li><a href="#pipe">pipe</a></li>
122128
<li><a href="#apply">apply</a></li>
123129
<li><a href="#putting-and-together">Putting @ and | together</a></li>
130+
</ul>
131+
</li>
124132
<li><a href="#general-tips">General Tips</a><ul>
125133
<li><a href="#type-checking">Type Checking</a></li>
126134
<li><a href="#functoolspartial">functools.partial</a></li>

0 commit comments

Comments
 (0)