Update documentation

Author: miguelgondu

_sources/contributing/a_new_solver.md

@@ -32,7 +32,7 @@ class AbstractSolver:
 
 i.e. the minimal ingredients required to instantiate a solver are a black-box function defined through `poli`, the initial design `x0`, and its evaluation `y0`.
 
-**The only abstract method required** is a `solve(max_iter: int)`, in which you can implement all the complex logic required to optimize the objective function for `max_iter` iterations.
+**The only abstract method required** is a `solve`, in which you can implement all the complex logic required to optimize the objective function for `max_iter: int` iterations.
 
 ```python
 # poli_baselines/core/abstract_solver.py
@@ -198,3 +198,5 @@ your_solver = YourSolver(
 # Optimize for a given number of iterations.
 your_solver.solve(10)
 ```
+
+Once you know your optimizer works in this setting, you can **submit a pull-request** to `poli-baselines`.

contributing/a_new_solver.html

@@ -748,7 +748,7 @@ <h2>An abstract problem solver<a class="headerlink" href="#an-abstract-problem-s
 </pre></div>
 </div>
 <p>i.e. the minimal ingredients required to instantiate a solver are a black-box function defined through <code class="docutils literal notranslate"><span class="pre">poli</span></code>, the initial design <code class="docutils literal notranslate"><span class="pre">x0</span></code>, and its evaluation <code class="docutils literal notranslate"><span class="pre">y0</span></code>.</p>
-<p><strong>The only abstract method required</strong> is a <code class="docutils literal notranslate"><span class="pre">solve(max_iter:</span> <span class="pre">int)</span></code>, in which you can implement all the complex logic required to optimize the objective function for <code class="docutils literal notranslate"><span class="pre">max_iter</span></code> iterations.</p>
+<p><strong>The only abstract method required</strong> is a <code class="docutils literal notranslate"><span class="pre">solve</span></code>, in which you can implement all the complex logic required to optimize the objective function for <code class="docutils literal notranslate"><span class="pre">max_iter:</span> <span class="pre">int</span></code> iterations.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># poli_baselines/core/abstract_solver.py</span>
 <span class="k">class</span> <span class="nc">AbstractSolver</span><span class="p">:</span>
     <span class="o">...</span>
@@ -898,6 +898,7 @@ <h2>Submitting a pull request<a class="headerlink" href="#submitting-a-pull-requ
 <span class="n">your_solver</span><span class="o">.</span><span class="n">solve</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
 </pre></div>
 </div>
+<p>Once you know your optimizer works in this setting, you can <strong>submit a pull-request</strong> to <code class="docutils literal notranslate"><span class="pre">poli-baselines</span></code>.</p>
 </section>
 </section>