Skip to content

Commit

Permalink
Revert __pdoc__ changes from previous commit.
Browse files Browse the repository at this point in the history
There is a pull request on the pdoc GitHub site:

  mitmproxy/pdoc#646

to include dunders if they have docstrings via

  pdoc --html --include-dunder grscheller.datastructures

This pull request is still a work in progress.
  • Loading branch information
grscheller committed Dec 12, 2023
1 parent 3b9f7e7 commit 825499d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 39 deletions.
28 changes: 2 additions & 26 deletions docs/API/development/html/grscheller/datastructures/core/fp.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,6 @@ <h1 class="title">Module <code>grscheller.datastructures.core.fp</code></h1>
- semantically None does not exist
- None only has any real existance as an implementration detail
&#34;&#34;&#34;
__pdoc__ = {}
__pdoc__[&#39;__iter__&#39;] = True
__pdoc__[&#39;__bool__&#39;] = True
__pdoc__[&#39;__len__&#39;] = True
__pdoc__[&#39;__eq__&#39;] = True

__slots__ = [&#39;value&#39;]

def __init__(self, value: Any=None):
Expand Down Expand Up @@ -173,20 +167,14 @@ <h1 class="title">Module <code>grscheller.datastructures.core.fp</code></h1>
&#34;&#34;&#34;
return Maybe(value)

#: Returns a &#34;Nothing&#34; (not a singleton!), test via equality, not identity.
#: Nothing is not a singleton! Test via equality, or in a boolean context.
Nothing: Maybe = Maybe()

class Either(FP):
&#34;&#34;&#34;Class that either contains a Left value or Right value, but not both. If
right not given, set it to the empty str. This version is biased to the
Left, which is intended as the &#34;happy path.&#34;
&#34;&#34;&#34;
__pdoc__ = {}
__pdoc__[&#39;__iter__&#39;] = True
__pdoc__[&#39;__bool__&#39;] = True
__pdoc__[&#39;__len__&#39;] = True
__pdoc__[&#39;__eq__&#39;] = True

__slots__ = [&#39;_isLeft&#39;, &#39;_value&#39;]

def __init__(self, left: Any=None, right: Any=None):
Expand Down Expand Up @@ -294,7 +282,7 @@ <h2 class="section-title" id="header-variables">Global variables</h2>
<dl>
<dt id="grscheller.datastructures.core.fp.Nothing"><code class="name">var <span class="ident">Nothing</span><a title="grscheller.datastructures.core.fp.Maybe" href="#grscheller.datastructures.core.fp.Maybe">Maybe</a></code></dt>
<dd>
<div class="desc"><p>Returns a "Nothing" (not a singleton!), test via equality, not identity.</p></div>
<div class="desc"><p>Nothing is not a singleton! Test via equality, or in a boolean context.</p></div>
</dd>
</dl>
</section>
Expand Down Expand Up @@ -396,12 +384,6 @@ <h2 class="section-title" id="header-classes">Classes</h2>
right not given, set it to the empty str. This version is biased to the
Left, which is intended as the &#34;happy path.&#34;
&#34;&#34;&#34;
__pdoc__ = {}
__pdoc__[&#39;__iter__&#39;] = True
__pdoc__[&#39;__bool__&#39;] = True
__pdoc__[&#39;__len__&#39;] = True
__pdoc__[&#39;__eq__&#39;] = True

__slots__ = [&#39;_isLeft&#39;, &#39;_value&#39;]

def __init__(self, left: Any=None, right: Any=None):
Expand Down Expand Up @@ -797,12 +779,6 @@ <h3>Methods</h3>
- semantically None does not exist
- None only has any real existance as an implementration detail
&#34;&#34;&#34;
__pdoc__ = {}
__pdoc__[&#39;__iter__&#39;] = True
__pdoc__[&#39;__bool__&#39;] = True
__pdoc__[&#39;__len__&#39;] = True
__pdoc__[&#39;__eq__&#39;] = True

__slots__ = [&#39;value&#39;]

def __init__(self, value: Any=None):
Expand Down
14 changes: 1 addition & 13 deletions src/grscheller/datastructures/core/fp.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,6 @@ class Maybe(FP):
- semantically None does not exist
- None only has any real existance as an implementration detail
"""
__pdoc__ = {}
__pdoc__['__iter__'] = True
__pdoc__['__bool__'] = True
__pdoc__['__len__'] = True
__pdoc__['__eq__'] = True

__slots__ = ['value']

def __init__(self, value: Any=None):
Expand Down Expand Up @@ -142,20 +136,14 @@ def Some(value=None) -> Maybe:
"""
return Maybe(value)

#: Returns a "Nothing" (not a singleton!), test via equality, not identity.
#: Nothing is not a singleton! Test via equality, or in a boolean context.
Nothing: Maybe = Maybe()

class Either(FP):
"""Class that either contains a Left value or Right value, but not both. If
right not given, set it to the empty str. This version is biased to the
Left, which is intended as the "happy path."
"""
__pdoc__ = {}
__pdoc__['__iter__'] = True
__pdoc__['__bool__'] = True
__pdoc__['__len__'] = True
__pdoc__['__eq__'] = True

__slots__ = ['_isLeft', '_value']

def __init__(self, left: Any=None, right: Any=None):
Expand Down

0 comments on commit 825499d

Please sign in to comment.