Skip to content

Commit

Permalink
updated haddocks
Browse files Browse the repository at this point in the history
  • Loading branch information
@ekmett
ekmett committed Jan 21, 2013
1 parent 8e12162 commit 4dd9f95
Show file tree
Hide file tree
Showing 12 changed files with 1,111 additions and 1,081 deletions.
4 changes: 3 additions & 1 deletion Control-Lens-Getter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@
<code><a href="Control-Lens-Traversal.html#t:Traversal">Traversal</a></code>), otherwise you can only pass this a
<code><a href="Control-Lens-Getter.html#t:Getter">Getter</a></code> or <code><a href="Control-Lens-Type.html#t:Lens">Lens</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:IndexedGetting" class="def">IndexedGetting</a> i m s t a b = <a href="Control-Lens-Internal-Indexed.html#t:Indexed">Indexed</a> i a (<a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m b) -&gt; s -&gt; <a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m t<a href="src/Control-Lens-Getter.html#IndexedGetting" class="link">Source</a></p><div class="doc"><p>Used to consume an <code><a href="Control-Lens-Fold.html#t:IndexedFold">IndexedFold</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Accessing" class="def">Accessing</a> p m s t a b = p a (<a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m b) -&gt; s -&gt; <a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m t<a href="src/Control-Lens-Getter.html#Accessing" class="link">Source</a></p></div><h1 id="g:2">Building Getters
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Accessing" class="def">Accessing</a> p m s t a b = p a (<a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m b) -&gt; s -&gt; <a href="Control-Lens-Getter.html#t:Accessor">Accessor</a> m t<a href="src/Control-Lens-Getter.html#Accessing" class="link">Source</a></p><div class="doc"><p>This is a convenient alias used when consuming (indexed) getters and (indexed) folds
in a highly general fashion.
</p></div></div><h1 id="g:2">Building Getters
</h1><div class="top"><p class="src"><a name="v:to" class="def">to</a> :: (s -&gt; a) -&gt; <a href="Control-Lens-Type.html#t:IndexPreservingGetter">IndexPreservingGetter</a> s a<a href="src/Control-Lens-Getter.html#to" class="link">Source</a></p><div class="doc"><p>Build a <code><a href="Control-Lens-Getter.html#t:Getter">Getter</a></code> from an arbitrary Haskell function.
</p><pre>
<code><a href="Control-Lens-Getter.html#v:to">to</a></code> f <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#v:.">.</a></code> <code><a href="Control-Lens-Getter.html#v:to">to</a></code> g &#8801; <code><a href="Control-Lens-Getter.html#v:to">to</a></code> (g <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Prelude.html#v:.">.</a></code> f)
Expand Down
8 changes: 6 additions & 2 deletions Control-Lens-Internal-Fold.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,9 @@
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Min" class="def">Min</a> a <a href="src/Control-Lens-Internal-Fold.html#Min" class="link">Source</a></p><div class="doc"><p>Used for <code><a href="Control-Lens-Fold.html#v:minimumOf">minimumOf</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:NoMin" class="def">NoMin</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:Min" class="def">Min</a> a</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:Min" class="caption collapser" onclick="toggleSection('i:Min')">Instances</p><div id="section.i:Min" class="show"><table><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> a =&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Fold.html#t:Min">Min</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ord">Ord</a> a =&gt; Semigroup (<a href="Control-Lens-Internal-Fold.html#t:Min">Min</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getMin" class="def">getMin</a> :: <a href="Control-Lens-Internal-Fold.html#t:Min">Min</a> a -&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Control-Lens-Internal-Fold.html#getMin" class="link">Source</a></p><div class="doc"><p>Obtain the minimum.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Leftmost" class="def">Leftmost</a> a <a href="src/Control-Lens-Internal-Fold.html#Leftmost" class="link">Source</a></p><div class="doc"><p>Used for <code><a href="Control-Lens-Fold.html#v:preview">preview</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:LPure" class="def">LPure</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:LLeaf" class="def">LLeaf</a> a</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:LStep" class="def">LStep</a> (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:Leftmost" class="caption collapser" onclick="toggleSection('i:Leftmost')">Instances</p><div id="section.i:Leftmost" class="show"><table><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Semigroup (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getLeftmost" class="def">getLeftmost</a> :: <a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a -&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Control-Lens-Internal-Fold.html#getLeftmost" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Rightmost" class="def">Rightmost</a> a <a href="src/Control-Lens-Internal-Fold.html#Rightmost" class="link">Source</a></p><div class="doc"><p>Used for <code><a href="Control-Lens-Fold.html#v:lastOf">lastOf</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:RPure" class="def">RPure</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:RLeaf" class="def">RLeaf</a> a</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:RStep" class="def">RStep</a> (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:Rightmost" class="caption collapser" onclick="toggleSection('i:Rightmost')">Instances</p><div id="section.i:Rightmost" class="show"><table><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Semigroup (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getRightmost" class="def">getRightmost</a> :: <a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a -&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Control-Lens-Internal-Fold.html#getRightmost" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:LPure" class="def">LPure</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:LLeaf" class="def">LLeaf</a> a</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:LStep" class="def">LStep</a> (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:Leftmost" class="caption collapser" onclick="toggleSection('i:Leftmost')">Instances</p><div id="section.i:Leftmost" class="show"><table><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Semigroup (<a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getLeftmost" class="def">getLeftmost</a> :: <a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a> a -&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Control-Lens-Internal-Fold.html#getLeftmost" class="link">Source</a></p><div class="doc"><p>Extract the <code><a href="Control-Lens-Internal-Fold.html#t:Leftmost">Leftmost</a></code> element. This will fairly eagerly determine that it can return <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#v:Just">Just</a></code>
the moment it sees any element at all.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Rightmost" class="def">Rightmost</a> a <a href="src/Control-Lens-Internal-Fold.html#Rightmost" class="link">Source</a></p><div class="doc"><p>Used for <code><a href="Control-Lens-Fold.html#v:lastOf">lastOf</a></code>.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:RPure" class="def">RPure</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:RLeaf" class="def">RLeaf</a> a</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a name="v:RStep" class="def">RStep</a> (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="subs instances"><p id="control.i:Rightmost" class="caption collapser" onclick="toggleSection('i:Rightmost')">Instances</p><div id="section.i:Rightmost" class="show"><table><tr><td class="src"><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Monoid.html#t:Monoid">Monoid</a> (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">Semigroup (<a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:getRightmost" class="def">getRightmost</a> :: <a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a> a -&gt; <a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> a<a href="src/Control-Lens-Internal-Fold.html#getRightmost" class="link">Source</a></p><div class="doc"><p>Extract the <code><a href="Control-Lens-Internal-Fold.html#t:Rightmost">Rightmost</a></code> element. This will fairly eagerly determine that it can return <code><a href="/Library/Frameworks/GHC.framework/Versions/7.4.1-x86_64/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#v:Just">Just</a></code>
the moment it sees any element at all.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
Loading

0 comments on commit 4dd9f95

Please sign in to comment.