Remove GameShark.tick from docs

Baekalfen · Oct 15, 2024 · 8cf3f1f · 8cf3f1f
1 parent 7b8ccd1
commit 8cf3f1f
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 24 deletions.
diff --git a/docs/api/gameshark.html b/docs/api/gameshark.html
@@ -34,6 +34,10 @@ <h1 class="title">Module <code>pyboy.api.gameshark</code></h1>
 
 logger = get_logger(__name__)
 
+__pdoc__ = {
+    &#34;GameShark.tick&#34;: False,
+}
+
 
 class GameShark:
     def __init__(self, memory):
@@ -462,25 +466,6 @@ <h2 id="args">Args</h2>
         self.remove(code, restore_value)</code></pre>
 </details>
 </dd>
-<dt id="pyboy.api.gameshark.GameShark.tick"><code class="name flex">
-<span>def <span class="ident">tick</span></span>(<span>self)</span>
-</code></dt>
-<dd>
-<section class="desc"></section>
-<details class="source">
-<summary>
-<span>Expand source code</span>
-</summary>
-<pre><code class="python">def tick(self):
-    if not self.enabled:
-        return
-    # https://gbdev.io/pandocs/Shark_Cheats.html
-    # &#34;As far as it is understood, patching is implemented by hooking the original VBlank interrupt handler, and
-    # re-writing RAM values each frame.&#34;
-    for _, (_, (_type, value, address)) in self.cheats.items():
-        self._set_value(_type, value, address)</code></pre>
-</details>
-</dd>
 </dl>
 </dd>
 </dl>
@@ -505,7 +490,6 @@ <h4><code><a title="pyboy.api.gameshark.GameShark" href="#pyboy.api.gameshark.Ga
 <li><code><a title="pyboy.api.gameshark.GameShark.add" href="#pyboy.api.gameshark.GameShark.add">add</a></code></li>
 <li><code><a title="pyboy.api.gameshark.GameShark.remove" href="#pyboy.api.gameshark.GameShark.remove">remove</a></code></li>
 <li><code><a title="pyboy.api.gameshark.GameShark.clear_all" href="#pyboy.api.gameshark.GameShark.clear_all">clear_all</a></code></li>
-<li><code><a title="pyboy.api.gameshark.GameShark.tick" href="#pyboy.api.gameshark.GameShark.tick">tick</a></code></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -42,10 +42,8 @@ <h1 class="title">Module <code>pyboy.api</code></h1>
 from .tilemap import TileMap
 
 # __pdoc__ = {
-#     &#34;constants&#34;: False,
-#     &#34;manager&#34;: False,
-# }
-# __all__ = [&#34;API&#34;]</code></pre>
+#     &#34;gameshark.GameShark.tick&#34;: False,
+# }</code></pre>
 </details>
 </section>
 <section>

diff --git a/pyboy/api/gameshark.py b/pyboy/api/gameshark.py
@@ -7,6 +7,10 @@
 
 logger = get_logger(__name__)
 
+__pdoc__ = {
+    "GameShark.tick": False,
+}
+
 
 class GameShark:
     def __init__(self, memory):