Skip to content

Commit ddc9f95

Browse files
Update documentation
1 parent b034d2c commit ddc9f95

17 files changed

+32
-32
lines changed

main/.doctrees/environment.pickle

101 KB
Binary file not shown.

main/generated/geometric_features.FeatureCollection.add_feature.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>geometric_features.FeatureCollection.add_feature<a class="headerlink" href="
118118
<dd><p>Add a feature to the feature collection if it isn’t already present</p>
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><strong>feature</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – The feature to add</p>
121+
<dd class="field-odd"><p><strong>feature</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – The feature to add</p>
122122
</dd>
123123
</dl>
124124
</dd></dl>

main/generated/geometric_features.FeatureCollection.combine.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,14 @@ <h1>geometric_features.FeatureCollection.combine<a class="headerlink" href="#geo
118118
<dd><p>Combines the geometry of the feature collection into a single feature</p>
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><strong>featureName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The name of the new, combined feature</p>
121+
<dd class="field-odd"><p><strong>featureName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The name of the new, combined feature</p>
122122
</dd>
123123
<dt class="field-even">Returns<span class="colon">:</span></dt>
124124
<dd class="field-even"><p><strong>fc</strong> (<em>geometric_features.FeatureCollection</em>) – A new feature collection with a single feature with the combined
125125
geometry</p>
126126
</dd>
127127
<dt class="field-odd">Raises<span class="colon">:</span></dt>
128-
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the combined geometry is of an unsupported type (typically
128+
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.14)"><strong>ValueError</strong></a> – If the combined geometry is of an unsupported type (typically
129129
<code class="docutils literal notranslate"><span class="pre">GeometryCollection</span></code>)</p>
130130
</dd>
131131
</dl>

main/generated/geometric_features.FeatureCollection.difference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h1>geometric_features.FeatureCollection.difference<a class="headerlink" href="#
121121
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
122122
<dd class="field-odd"><ul class="simple">
123123
<li><p><strong>maskingFC</strong> (<a class="reference internal" href="geometric_features.FeatureCollection.html#geometric_features.FeatureCollection" title="geometric_features.FeatureCollection"><em>geometric_features.FeatureCollection</em></a>) – Another collection of one or more features to use as masks</p></li>
124-
<li><p><strong>show_progress</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a>) – Show a progress bar</p></li>
124+
<li><p><strong>show_progress</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a>) – Show a progress bar</p></li>
125125
</ul>
126126
</dd>
127127
<dt class="field-even">Returns<span class="colon">:</span></dt>

main/generated/geometric_features.FeatureCollection.feature_in_collection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>geometric_features.FeatureCollection.feature_in_collection<a class="headerli
118118
<dd><p>Is this feature already in the collection?</p>
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><strong>feature</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – The feature to check</p>
121+
<dd class="field-odd"><p><strong>feature</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – The feature to check</p>
122122
</dd>
123123
<dt class="field-even">Returns<span class="colon">:</span></dt>
124124
<dd class="field-even"><p><strong>inCollection</strong> (<em>bool</em>) – Whether the feature is in the collection</p>

main/generated/geometric_features.FeatureCollection.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ <h1>geometric_features.FeatureCollection<a class="headerlink" href="#geometric-f
110110
<dl class="field-list simple">
111111
<dt class="field-odd">Variables<span class="colon">:</span></dt>
112112
<dd class="field-odd"><ul class="simple">
113-
<li><p><strong>features</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – A list of python dictionaries describing each feature, following the
113+
<li><p><strong>features</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – A list of python dictionaries describing each feature, following the
114114
geojson convention</p></li>
115-
<li><p><strong>otherProperties</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a>) – Other properties of the feature collection such as <code class="docutils literal notranslate"><span class="pre">type</span></code> and
115+
<li><p><strong>otherProperties</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a>) – Other properties of the feature collection such as <code class="docutils literal notranslate"><span class="pre">type</span></code> and
116116
<code class="docutils literal notranslate"><span class="pre">groupName</span></code></p></li>
117117
</ul>
118118
</dd>
@@ -124,9 +124,9 @@ <h1>geometric_features.FeatureCollection<a class="headerlink" href="#geometric-f
124124
<dl class="field-list simple">
125125
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
126126
<dd class="field-odd"><ul class="simple">
127-
<li><p><strong>features</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a><em>, </em><em>optional</em>) – A list of python dictionaries describing each feature, following
127+
<li><p><strong>features</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a><em>, </em><em>optional</em>) – A list of python dictionaries describing each feature, following
128128
the geojson convention</p></li>
129-
<li><p><strong>otherProperties</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><em>dict</em></a><em>, </em><em>optional</em>) – Other properties of the feature collection such as <code class="docutils literal notranslate"><span class="pre">type</span></code> and
129+
<li><p><strong>otherProperties</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.14)"><em>dict</em></a><em>, </em><em>optional</em>) – Other properties of the feature collection such as <code class="docutils literal notranslate"><span class="pre">type</span></code> and
130130
<code class="docutils literal notranslate"><span class="pre">groupName</span></code></p></li>
131131
</ul>
132132
</dd>

main/generated/geometric_features.FeatureCollection.plot.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ <h1>geometric_features.FeatureCollection.plot<a class="headerlink" href="#geomet
127127
‘pacific’, ‘americas’, ‘asia’</p>
128128
</div></blockquote>
129129
</p></li>
130-
<li><p><strong>maxLength</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><em>optional</em>) – Maximum allowed segment length after subdivision for smoother
130+
<li><p><strong>maxLength</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em>, </em><em>optional</em>) – Maximum allowed segment length after subdivision for smoother
131131
plotting (0.0 indicates skip subdivision)</p></li>
132-
<li><p><strong>figsize</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><em>tuple</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a>) – Size of the figure in inches</p></li>
133-
<li><p><strong>colors</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Colors to cycle through for the shapes</p></li>
134-
<li><p><strong>dpi</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Dots per inch for the figure</p></li>
132+
<li><p><strong>figsize</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.14)"><em>tuple</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a>) – Size of the figure in inches</p></li>
133+
<li><p><strong>colors</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – Colors to cycle through for the shapes</p></li>
134+
<li><p><strong>dpi</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.14)"><em>int</em></a>) – Dots per inch for the figure</p></li>
135135
</ul>
136136
</dd>
137137
<dt class="field-even">Returns<span class="colon">:</span></dt>

main/generated/geometric_features.FeatureCollection.set_group_name.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>geometric_features.FeatureCollection.set_group_name<a class="headerlink" hre
118118
<dd><p>Set the group name of a feature collection</p>
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><strong>groupName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – The group name</p>
121+
<dd class="field-odd"><p><strong>groupName</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – The group name</p>
122122
</dd>
123123
</dl>
124124
</dd></dl>

main/generated/geometric_features.FeatureCollection.simplify.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h1>geometric_features.FeatureCollection.simplify<a class="headerlink" href="#ge
118118
<dd><p>Features in the collection are simplified using <code class="docutils literal notranslate"><span class="pre">shapely</span></code></p>
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121-
<dd class="field-odd"><p><strong>tolerance</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><em>float</em></a><em>, </em><em>optional</em>) – The tolerance in degrees lon/lat allowed when simplifying shapes</p>
121+
<dd class="field-odd"><p><strong>tolerance</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.14)"><em>float</em></a><em>, </em><em>optional</em>) – The tolerance in degrees lon/lat allowed when simplifying shapes</p>
122122
</dd>
123123
<dt class="field-even">Returns<span class="colon">:</span></dt>
124124
<dd class="field-even"><p><strong>fc</strong> (<em>geometric_features.FeatureCollection</em>) – A new feature collection with simplified geometries</p>

main/generated/geometric_features.FeatureCollection.tag.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ <h1>geometric_features.FeatureCollection.tag<a class="headerlink" href="#geometr
119119
<dl class="field-list simple">
120120
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
121121
<dd class="field-odd"><ul class="simple">
122-
<li><p><strong>tags</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Tags to be added</p></li>
123-
<li><p><strong>remove</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to remove the tag rather than adding it</p></li>
122+
<li><p><strong>tags</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.14)"><em>list</em></a><em> of </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><em>str</em></a>) – Tags to be added</p></li>
123+
<li><p><strong>remove</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.14)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to remove the tag rather than adding it</p></li>
124124
</ul>
125125
</dd>
126126
</dl>

0 commit comments

Comments
 (0)