Skip to content

Commit

Permalink
updated haddocks
Browse files Browse the repository at this point in the history
  • Loading branch information
ekmett committed Oct 13, 2013
1 parent 464fb0d commit 2421cf8
Show file tree
Hide file tree
Showing 77 changed files with 7,376 additions and 6,982 deletions.
70 changes: 35 additions & 35 deletions Control-Exception-Lens.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions Control-Lens-At.html
Expand Up @@ -19,11 +19,11 @@
you cannot satisfy the <code><a href="Control-Lens-Type.html#t:Lens">Lens</a></code> laws.
</p></div></div><div class="subs instances"><p id="control.i:At" class="caption collapser" onclick="toggleSection('i:At')">Instances</p><div id="section.i:At" class="show"><table><tr><td class="src"><a href="Control-Lens-At.html#t:At">At</a> <a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-IntSet.html#t:IntSet">IntSet</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Control-Lens-At.html#t:At">At</a> (<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="Control-Lens-At.html#t:At">At</a> (<a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-IntMap-Strict.html#t:IntMap">IntMap</a> a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Ord.html#t:Ord">Ord</a> k =&gt; <a href="Control-Lens-At.html#t:At">At</a> (<a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Set.html#t:Set">Set</a> k)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">(<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> k, Hashable k) =&gt; <a href="Control-Lens-At.html#t:At">At</a> (HashSet k)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Ord.html#t:Ord">Ord</a> k =&gt; <a href="Control-Lens-At.html#t:At">At</a> (<a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a> k a)</td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">(<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> k, Hashable k) =&gt; <a href="Control-Lens-At.html#t:At">At</a> (HashMap k a)</td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:sans" class="def">sans</a> :: <a href="Control-Lens-At.html#t:At">At</a> m =&gt; <a href="Control-Lens-At.html#t:Index">Index</a> m -&gt; m -&gt; m<a href="src/Control-Lens-At.html#sans" class="link">Source</a></p></div><h1 id="g:2">Ixed
</h1><div class="top"><p class="src"><span class="keyword">type family</span> <a name="t:Index" class="def">Index</a> s :: *<a href="src/Control-Lens-At.html#Index" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">type family</span> <a name="t:IxValue" class="def">IxValue</a> m :: *<a href="src/Control-Lens-At.html#IxValue" class="link">Source</a></p><div class="doc"><p>This provides a common notion of a value at an index that is shared by both <code><a href="Control-Lens-At.html#t:Ixed">Ixed</a></code> and <code><a href="Control-Lens-At.html#t:At">At</a></code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Ixed" class="def">Ixed</a> m <span class="keyword">where</span><a href="src/Control-Lens-At.html#Ixed" class="link">Source</a></p><div class="doc"><p>This simple <code><a href="Control-Lens-Type.html#t:IndexedTraversal">IndexedTraversal</a></code> lets you <code><a href="Control-Lens-Traversal.html#v:traverse">traverse</a></code> the value at a given
</p></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Ixed" class="def">Ixed</a> m <span class="keyword">where</span><a href="src/Control-Lens-At.html#Ixed" class="link">Source</a></p><div class="doc"><p>This simple <code>AffineTraversal</code> lets you <code><a href="Control-Lens-Traversal.html#v:traverse">traverse</a></code> the value at a given
key in a <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a></code> or element at an ordinal position in a list or <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code>.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:ix" class="def">ix</a> :: <a href="Control-Lens-At.html#t:Index">Index</a> m -&gt; <a href="Control-Lens-Type.html#t:Traversal-39-">Traversal'</a> m (<a href="Control-Lens-At.html#t:IxValue">IxValue</a> m)<a href="src/Control-Lens-At.html#ix" class="link">Source</a></p><div class="doc"><p>This simple <code><a href="Control-Lens-Type.html#t:IndexedTraversal">IndexedTraversal</a></code> lets you <code><a href="Control-Lens-Traversal.html#v:traverse">traverse</a></code> the value at a given
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:ix" class="def">ix</a> :: <a href="Control-Lens-At.html#t:Index">Index</a> m -&gt; <a href="Control-Lens-Type.html#t:Traversal-39-">Traversal'</a> m (<a href="Control-Lens-At.html#t:IxValue">IxValue</a> m)<a href="src/Control-Lens-At.html#ix" class="link">Source</a></p><div class="doc"><p>This simple <code>AffineTraversal</code> lets you <code><a href="Control-Lens-Traversal.html#v:traverse">traverse</a></code> the value at a given
key in a <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Map-Lazy.html#t:Map">Map</a></code> or element at an ordinal position in a list or <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code>.
</p><p><em>NB:</em> Setting the value of this <code><a href="Control-Lens-Type.html#t:Traversal">Traversal</a></code> will only set the value in the
</p><p><em>NB:</em> Setting the value of this <code>AffineTraversal</code> will only set the value in the
<code><a href="Control-Lens-Type.html#t:Lens">Lens</a></code> if it is already present.
</p><p>If you want to be able to insert <em>missing</em> values, you want <code><a href="Control-Lens-At.html#v:at">at</a></code>.
</p><pre class="screen"><code class="prompt">&gt;&gt;&gt; </code><strong class="userinput"><code>Seq.fromList [a,b,c,d] &amp; ix 2 %~ f
Expand Down
6 changes: 3 additions & 3 deletions Control-Lens-Cons.html
Expand Up @@ -3,10 +3,10 @@
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Control-Lens-Cons.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">lens-3.10: Lenses, Folds and Traversals</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Edward Kmett &lt;ekmett@gmail.com&gt;</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr></table><p class="caption">Control.Lens.Cons</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Cons
</a></li><li><a href="#g:2">Snoc
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty">&nbsp;</div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a href="#t:Cons">Cons</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><ul class="subs"><li><a href="#v:_Cons">_Cons</a> :: <a href="Control-Lens-Type.html#t:Overloaded">Overloaded</a> p f s t (a, s) (b, t)</li></ul></li><li class="src short"><a href="#v:-60--124-">(&lt;|)</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; a -&gt; s -&gt; s</li><li class="src short"><a href="#v:cons">cons</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; a -&gt; s -&gt; s</li><li class="src short"><a href="#v:uncons">uncons</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) (<a href="Control-Lens-Getter.html#t:Const">Const</a> (<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Monoid.html#t:First">First</a> (a, s))) s s a a =&gt; s -&gt; <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> (a, s)</li><li class="src short"><a href="#v:_head">_head</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s a</li><li class="src short"><a href="#v:_tail">_tail</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s s</li><li class="src short"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a href="#t:Snoc">Snoc</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><ul class="subs"><li><a href="#v:_Snoc">_Snoc</a> :: <a href="Control-Lens-Type.html#t:Overloaded">Overloaded</a> p f s t (s, a) (t, b)</li></ul></li><li class="src short"><a href="#v:-124--62-">(|&gt;)</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; s -&gt; a -&gt; s</li><li class="src short"><a href="#v:snoc">snoc</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; s -&gt; a -&gt; s</li><li class="src short"><a href="#v:unsnoc">unsnoc</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) (<a href="Control-Lens-Getter.html#t:Const">Const</a> (<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Monoid.html#t:First">First</a> (s, a))) s s a a =&gt; s -&gt; <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> (s, a)</li><li class="src short"><a href="#v:_init">_init</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s s</li><li class="src short"><a href="#v:_last">_last</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s a</li></ul></div><div id="interface"><h1 id="g:1">Cons
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty">&nbsp;</div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a href="#t:Cons">Cons</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><ul class="subs"><li><a href="#v:_Cons">_Cons</a> :: <a href="Control-Lens-Type.html#t:Optic">Optic</a> p f s t (a, s) (b, t)</li></ul></li><li class="src short"><a href="#v:-60--124-">(&lt;|)</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; a -&gt; s -&gt; s</li><li class="src short"><a href="#v:cons">cons</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; a -&gt; s -&gt; s</li><li class="src short"><a href="#v:uncons">uncons</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) (<a href="Control-Lens-Getter.html#t:Const">Const</a> (<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Monoid.html#t:First">First</a> (a, s))) s s a a =&gt; s -&gt; <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> (a, s)</li><li class="src short"><a href="#v:_head">_head</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s a</li><li class="src short"><a href="#v:_tail">_tail</a> :: <a href="Control-Lens-Cons.html#t:Cons">Cons</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s s</li><li class="src short"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a href="#t:Snoc">Snoc</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><ul class="subs"><li><a href="#v:_Snoc">_Snoc</a> :: <a href="Control-Lens-Type.html#t:Optic">Optic</a> p f s t (s, a) (t, b)</li></ul></li><li class="src short"><a href="#v:-124--62-">(|&gt;)</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; s -&gt; a -&gt; s</li><li class="src short"><a href="#v:snoc">snoc</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> Tagged <a href="Control-Lens-Setter.html#t:Identity">Identity</a> s s a a =&gt; s -&gt; a -&gt; s</li><li class="src short"><a href="#v:unsnoc">unsnoc</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) (<a href="Control-Lens-Getter.html#t:Const">Const</a> (<a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Monoid.html#t:First">First</a> (s, a))) s s a a =&gt; s -&gt; <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Data-Maybe.html#t:Maybe">Maybe</a> (s, a)</li><li class="src short"><a href="#v:_init">_init</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s s</li><li class="src short"><a href="#v:_last">_last</a> :: <a href="Control-Lens-Cons.html#t:Snoc">Snoc</a> (-&gt;) f s s a a =&gt; <a href="Control-Lens-Type.html#t:LensLike-39-">LensLike'</a> f s a</li></ul></div><div id="interface"><h1 id="g:1">Cons
</h1><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a name="t:Cons" class="def">Cons</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><a href="src/Control-Lens-Cons.html#Cons" class="link">Source</a></p><div class="doc"><p>This class provides a way to attach or detach elements on the left
side of a structure in a flexible manner.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:_Cons" class="def">_Cons</a> :: <a href="Control-Lens-Type.html#t:Overloaded">Overloaded</a> p f s t (a, s) (b, t)<a href="src/Control-Lens-Cons.html#_Cons" class="link">Source</a></p><div class="doc"><p>Most of the time this is a <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code>.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:_Cons" class="def">_Cons</a> :: <a href="Control-Lens-Type.html#t:Optic">Optic</a> p f s t (a, s) (b, t)<a href="src/Control-Lens-Cons.html#_Cons" class="link">Source</a></p><div class="doc"><p>Most of the time this is a <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code>.
</p><pre>
<code><a href="Control-Lens-Cons.html#v:_Cons">_Cons</a></code> :: <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code> [a] [b] (a, [a]) (b, [b])
<code><a href="Control-Lens-Cons.html#v:_Cons">_Cons</a></code> :: <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code> (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> a) (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> b) (a, <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> a) (b, <code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> b)
Expand Down Expand Up @@ -106,7 +106,7 @@
</pre></div></div><h1 id="g:2">Snoc
</h1><div class="top"><p class="src"><span class="keyword">class</span> (<a href="Control-Lens-Iso.html#t:Profunctor">Profunctor</a> p, <a href="/usr/local/share/doc/ghc/html/libraries/base-4.6.0.1/Control-Monad.html#t:Functor">Functor</a> f) =&gt; <a name="t:Snoc" class="def">Snoc</a> p f s t a b | s -&gt; a, t -&gt; b, s b -&gt; t, t a -&gt; s <span class="keyword">where</span><a href="src/Control-Lens-Cons.html#Snoc" class="link">Source</a></p><div class="doc"><p>This class provides a way to attach or detach elements on the right
side of a structure in a flexible manner.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:_Snoc" class="def">_Snoc</a> :: <a href="Control-Lens-Type.html#t:Overloaded">Overloaded</a> p f s t (s, a) (t, b)<a href="src/Control-Lens-Cons.html#_Snoc" class="link">Source</a></p><div class="doc"><p>Most of the time this is a <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code>.
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:_Snoc" class="def">_Snoc</a> :: <a href="Control-Lens-Type.html#t:Optic">Optic</a> p f s t (s, a) (t, b)<a href="src/Control-Lens-Cons.html#_Snoc" class="link">Source</a></p><div class="doc"><p>Most of the time this is a <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code>.
</p><pre>
<code><a href="Control-Lens-Cons.html#v:_Snoc">_Snoc</a></code> :: <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code> [a] [b] ([a], a) ([b], b)
<code><a href="Control-Lens-Cons.html#v:_Snoc">_Snoc</a></code> :: <code><a href="Control-Lens-Type.html#t:Prism">Prism</a></code> (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> a) (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> b) (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> a, a) (<code><a href="/usr/local/share/doc/ghc/html/libraries/containers-0.5.0.0/Data-Sequence.html#t:Seq">Seq</a></code> b, b)
Expand Down
2 changes: 1 addition & 1 deletion Control-Lens-Each.html

Large diffs are not rendered by default.

0 comments on commit 2421cf8

Please sign in to comment.