Update documentation

_sources/lib/Api.rst.txt

@@ -101,7 +101,7 @@ Calling Double Elimination API
     score, status = DoubleElim.get_score()
     print(f"The current score of the game is {score}, the server responded with status code: {status}")
 
-    meteoroids, status = DoubleElim.get_meteoroid()
+    meteoroids, status = DoubleElim.get_meteoroids()
     print(f"The current meteoroids in the game are {meteoroids}, the server responded with status code: {status}")
 
 In this second example we wait until the game is started by the judges and then make all possible requests once. You should use the wait_for_start function in your double elimination program. If your robot starts too soon your run will not count!

genindex.html

@@ -168,7 +168,7 @@
 </li>
       <li><a href="lib/Api.html#compLib.Api.Seeding.get_material">get_material() (compLib.Api.Seeding static method)</a>
 </li>
-      <li><a href="lib/Api.html#compLib.Api.DoubleElim.get_meteoroid">get_meteoroid() (compLib.Api.DoubleElim static method)</a>
+      <li><a href="lib/Api.html#compLib.Api.DoubleElim.get_meteoroids">get_meteoroids() (compLib.Api.DoubleElim static method)</a>
 </li>
       <li><a href="lib/Motor.html#compLib.Motor.Motor.get_motor_curve">get_motor_curve() (compLib.Motor.Motor static method)</a>
 </li>

lib/Api.html

@@ -205,9 +205,9 @@
 </dd></dl>
 
 <dl class="py method">
-<dt class="sig sig-object py" id="compLib.Api.DoubleElim.get_meteoroid">
+<dt class="sig sig-object py" id="compLib.Api.DoubleElim.get_meteoroids">
-<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_meteoroid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.Api.DoubleElim.get_meteoroid" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">static</span> </em><span class="sig-name descname"><span class="pre">get_meteoroids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.Api.DoubleElim.get_meteoroids" title="Permalink to this definition"></a></dt>
-<dd><p>Makes the /api/getMeteoroid call to the api.</p>
+<dd><p>Makes the /api/getMeteoroids call to the api.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns</dt>
 <dd class="field-odd"><p>A list will all meteoroids currently on the game field. Meteoroids are dictionaries that look like: {“x”: 0, “y”: 0}</p>
@@ -344,7 +344,7 @@
 <span class="n">score</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_score</span><span class="p">()</span>
 <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The current score of the game is </span><span class="si">{</span><span class="n">score</span><span class="si">}</span><span class="s2">, the server responded with status code: </span><span class="si">{</span><span class="n">status</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
-<span class="n">meteoroids</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_meteoroid</span><span class="p">()</span>
+<span class="n">meteoroids</span><span class="p">,</span> <span class="n">status</span> <span class="o">=</span> <span class="n">DoubleElim</span><span class="o">.</span><span class="n">get_meteoroids</span><span class="p">()</span>
 <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The current meteoroids in the game are </span><span class="si">{</span><span class="n">meteoroids</span><span class="si">}</span><span class="s2">, the server responded with status code: </span><span class="si">{</span><span class="n">status</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 </pre></div>
 </div>