Skip to content

Commit 014203e

Browse files
committed
v3.18.1 documentation
1 parent 9565453 commit 014203e

File tree

4,633 files changed

+172021
-184718
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,633 files changed

+172021
-184718
lines changed

docs/2_to_3_changes.html

Lines changed: 37 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,48 @@
1-
21
<!DOCTYPE html>
32

4-
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<html lang="en" data-content_root="./">
54
<head>
6-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
5+
<meta charset="utf-8" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<title>Incompatible differences between versions 2.x and 3.x &#8212; Documentation</title>
9-
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
10-
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
11-
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
12-
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
13-
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css" />
14-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
15-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
16-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
17-
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
18-
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
19-
<script src="_static/jquery.js"></script>
20-
<script src="_static/underscore.js"></script>
21-
<script src="_static/doctools.js"></script>
22-
<script src="_static/language_data.js"></script>
23-
<script src="_static/clipboard.min.js"></script>
24-
<script src="_static/copybutton.js"></script>
25-
<script src="_static/toggleprompt.js"></script>
26-
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
27-
<link rel="shortcut icon" href="_static/favicon.ico"/>
9+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
10+
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=a5d0ad34" />
11+
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
12+
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
13+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
14+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
15+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
16+
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
17+
<link rel="stylesheet" type="text/css" href="_static/customise-alabaster.css?v=5dec66a6" />
18+
<script src="_static/documentation_options.js?v=64e044ff"></script>
19+
<script src="_static/doctools.js?v=9bcbadda"></script>
20+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
21+
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
22+
<script src="_static/copybutton.js?v=b578dfe4"></script>
23+
<script src="_static/toggleprompt.js?v=1b41717f"></script>
24+
<link rel="icon" href="_static/favicon.ico"/>
2825
<link rel="index" title="Index" href="genindex.html" />
2926
<link rel="search" title="Search" href="search.html" />
3027

3128
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
3229

30+
31+
3332

34-
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
3533

3634
</head><body>
3735
<div class="document">
3836

39-
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
37+
<div class="sphinxsidebar" role="navigation" aria-label="Main">
4038
<div class="sphinxsidebarwrapper">
4139
<p class="logo"><a href="index.html">
42-
<img class="logo" src="_static/logo.svg" alt="Logo"/>
40+
<img class="logo" src="_static/logo.svg" alt="Logo of Python cf package"/>
4341
</a></p>
4442

4543

4644

47-
<h1 class="logo"><a href="index.html">cf 3.18.0</a></h1>
45+
<h1 class="logo"><a href="index.html">cf 3.18.1</a></h1>
4846

4947

5048

@@ -63,16 +61,16 @@ <h1 class="logo"><a href="index.html">cf 3.18.0</a></h1>
6361

6462

6563

66-
<div id="searchbox" style="display: none" role="search">
64+
<search id="searchbox" style="display: none" role="search">
6765
<h3 id="searchlabel">Quick search</h3>
6866
<div class="searchformwrapper">
6967
<form class="search" action="search.html" method="get">
70-
<input type="text" name="q" aria-labelledby="searchlabel" />
68+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
7169
<input type="submit" value="Go" />
7270
</form>
7371
</div>
74-
</div>
75-
<script>$('#searchbox').show(0);</script>
72+
</search>
73+
<script>document.getElementById('searchbox').style.display = "block"</script>
7674
<ul>
7775
<li class="toctree-l1"><a class="reference internal" href="introduction.html"><strong>Introduction</strong></a></li>
7876
<li class="toctree-l1"><a class="reference internal" href="installation.html"><strong>Installation</strong></a></li>
@@ -122,7 +120,7 @@ <h3>Related Topics</h3>
122120
<div class="body" role="main">
123121

124122
<section id="incompatible-differences-between-versions-2-x-and-3-x">
125-
<span id="two-to-three-changes"></span><h1>Incompatible differences between versions 2.x and 3.x<a class="headerlink" href="#incompatible-differences-between-versions-2-x-and-3-x" title="Permalink to this headline"></a></h1>
123+
<span id="two-to-three-changes"></span><h1>Incompatible differences between versions 2.x and 3.x<a class="headerlink" href="#incompatible-differences-between-versions-2-x-and-3-x" title="Link to this heading"></a></h1>
126124
<p>For those familiar with the cf-python API at version 2.x, some
127125
important, backwards incompatible changes were introduced at version
128126
3.0.0.</p>
@@ -134,12 +132,12 @@ <h3>Related Topics</h3>
134132
<p>For version 2.x documentation, see the <a class="reference internal" href="releases.html#releases"><span class="std std-ref">releases</span></a>
135133
page.</p>
136134
<section id="python">
137-
<h2>Python<a class="headerlink" href="#python" title="Permalink to this headline"></a></h2>
135+
<h2>Python<a class="headerlink" href="#python" title="Link to this heading"></a></h2>
138136
<p>Version 3.x only works for Python 3.5 or later. Version 2.x only works
139137
for python version 2.7.</p>
140138
</section>
141139
<section id="in-place-operations">
142-
<h2>In-place operations<a class="headerlink" href="#in-place-operations" title="Permalink to this headline"></a></h2>
140+
<h2>In-place operations<a class="headerlink" href="#in-place-operations" title="Link to this heading"></a></h2>
143141
<p>At version 3.x, in-place operations return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, rather than the
144142
modified construct. The keyword that defines the operation to be
145143
in-place is now <em>inplace</em> (rather than <em>i</em>).</p>
@@ -153,7 +151,7 @@ <h2>In-place operations<a class="headerlink" href="#in-place-operations" title="
153151
</div>
154152
</section>
155153
<section id="field-creation">
156-
<h2>Field creation<a class="headerlink" href="#field-creation" title="Permalink to this headline"></a></h2>
154+
<h2>Field creation<a class="headerlink" href="#field-creation" title="Link to this heading"></a></h2>
157155
<p>Field construct creation is has changed in two notable ways:</p>
158156
<p>Firstly, a single method <a class="reference internal" href="method/cf.Field.set_construct.html#cf.Field.set_construct" title="cf.Field.set_construct"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.Field.set_construct</span></code></a> has replaced the
159157
separated methods for each construct type
@@ -176,13 +174,9 @@ <h2>Field creation<a class="headerlink" href="#field-creation" title="Permalink
176174
in the above example).</p>
177175
</section>
178176
<section id="new-methods-that-replace-deprecated-ones">
179-
<h2>New methods that replace deprecated ones<a class="headerlink" href="#new-methods-that-replace-deprecated-ones" title="Permalink to this headline"></a></h2>
177+
<h2>New methods that replace deprecated ones<a class="headerlink" href="#new-methods-that-replace-deprecated-ones" title="Link to this heading"></a></h2>
180178
<p>Version 3.x methods that replace deprecated version 2.x methods:</p>
181179
<table class="docutils align-default">
182-
<colgroup>
183-
<col style="width: 64%" />
184-
<col style="width: 36%" />
185-
</colgroup>
186180
<thead>
187181
<tr class="row-odd"><th class="head"><p>Version 3.x</p></th>
188182
<th class="head"><p>Version 2.x</p></th>
@@ -246,13 +240,9 @@ <h2>New methods that replace deprecated ones<a class="headerlink" href="#new-met
246240
</table>
247241
</section>
248242
<section id="changes-to-the-api-of-existing-methods">
249-
<h2>Changes to the API of existing methods<a class="headerlink" href="#changes-to-the-api-of-existing-methods" title="Permalink to this headline"></a></h2>
243+
<h2>Changes to the API of existing methods<a class="headerlink" href="#changes-to-the-api-of-existing-methods" title="Link to this heading"></a></h2>
250244
<p>Methods that have a different API in version 3.x</p>
251245
<table class="docutils align-default">
252-
<colgroup>
253-
<col style="width: 38%" />
254-
<col style="width: 62%" />
255-
</colgroup>
256246
<thead>
257247
<tr class="row-odd"><th class="head"><p>Version 3.x</p></th>
258248
<th class="head"><p>API changes compared to version 2.x</p></th>
@@ -489,11 +479,11 @@ <h2>Changes to the API of existing methods<a class="headerlink" href="#changes-
489479
<div class="clearer"></div>
490480
</div>
491481
<div class="footer">
492-
&copy;2025, NCAS | Page built on 2025-06-05.
482+
&#169;2025, NCAS | Page built on 2025-08-20.
493483

494484
|
495-
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>
496-
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
485+
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
486+
&amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
497487

498488
</div>
499489

0 commit comments

Comments
 (0)