Merge branch 'topics/docs'

MICS-Lab · Nov 23, 2023 · e345420 · e345420
2 parents 500ae97 + e675f5d
commit e345420
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 5 deletions.
diff --git a/doc-sources/user-guide.rst b/doc-sources/user-guide.rst
@@ -75,7 +75,7 @@ the ``min_value`` and ``max_value`` keys describe the range of values the criter
 Categories
 ^^^^^^^^^^
 
-The fourth key in the problem file, ``categories``, is a list of the descriptions of the categories of the problem.
+The fourth key in the problem file, ``ordered_categories``, is a list of the descriptions of the categories of the problem.
 It must contain at least two elements because classification problems must have at least two categories.
 
 It must be sorted in increasing order: lower categories first and upper categories last.

diff --git a/doc-sources/user-guide.rst.tmpl b/doc-sources/user-guide.rst.tmpl
@@ -56,7 +56,7 @@ the ``min_value`` and ``max_value`` keys describe the range of values the criter
 Categories
 ^^^^^^^^^^
 
-The fourth key in the problem file, ``categories``, is a list of the descriptions of the categories of the problem.
+The fourth key in the problem file, ``ordered_categories``, is a list of the descriptions of the categories of the problem.
 It must contain at least two elements because classification problems must have at least two categories.
 
 It must be sorted in increasing order: lower categories first and upper categories last.

diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/user-guide.doctree b/docs/.doctrees/user-guide.doctree
diff --git a/docs/_sources/user-guide.rst.txt b/docs/_sources/user-guide.rst.txt
@@ -75,7 +75,7 @@ the ``min_value`` and ``max_value`` keys describe the range of values the criter
 Categories
 ^^^^^^^^^^
 
-The fourth key in the problem file, ``categories``, is a list of the descriptions of the categories of the problem.
+The fourth key in the problem file, ``ordered_categories``, is a list of the descriptions of the categories of the problem.
 It must contain at least two elements because classification problems must have at least two categories.
 
 It must be sorted in increasing order: lower categories first and upper categories last.

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/user-guide.html b/docs/user-guide.html
@@ -86,7 +86,7 @@ <h4>Criteria<a class="headerlink" href="#criteria" title="Permalink to this head
 </section>
 <section id="categories">
 <h4>Categories<a class="headerlink" href="#categories" title="Permalink to this heading">¶</a></h4>
-<p>The fourth key in the problem file, <code class="docutils literal notranslate"><span class="pre">categories</span></code>, is a list of the descriptions of the categories of the problem.
+<p>The fourth key in the problem file, <code class="docutils literal notranslate"><span class="pre">ordered_categories</span></code>, is a list of the descriptions of the categories of the problem.
 It must contain at least two elements because classification problems must have at least two categories.</p>
 <p>It must be sorted in increasing order: lower categories first and upper categories last.</p>
 <p>Its elements are relatively simple as they only get a <code class="docutils literal notranslate"><span class="pre">name</span></code>.</p>