Merge pull request #131 from PagerDuty/v5.2.0-typehints-tag-support

V5.2.0: Return type hints and tags API support
PagerDuty · Jan 5, 2024 · f0cdd6a · f0cdd6a
2 parents 5e37067 + 2365e49
commit f0cdd6a
Show file tree

Hide file tree

Showing 16 changed files with 323 additions and 230 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,14 @@
+**2023-12-28: Version 5.2.0:**
+
+* Expanded use of type hints in place of ``:rtype`` Sphinx directive
+* Remove unused dependency ``deprecation``
+* Fix bug: path ``/tags/{id}/{entity_type}`` breaks entity wrapping logic (`issue #130 <https://github.com/PagerDuty/pdpyras/issues/130>`_)
+
+**2023-11-15: Version 5.1.3:**
+
+* Remove deprecated escape sequences, which were causing downstream linter/unit test errors, from docstrings
+* Remove references to removed properties from the module reference that were causing Sphinx warnings
+
 **2023-09-12: Version 5.1.2:**
 
 * Address issue `#115 <https://github.com/PagerDuty/pdpyras/issues/115>`_ by adding default values to :attr:`pdpyras.PDSession.retry` for Events and Change Events API client classes

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '5.1.3',
+    VERSION: '5.2.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Changelog &#8212; PagerDuty Python REST API Sessions 5.1.3 documentation</title>
+    <title>Changelog &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -37,6 +37,17 @@
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading">¶</a></h1>
+<p><strong>2023-12-28: Version 5.2.0:</strong></p>
+<ul class="simple">
+<li><p>Expanded use of type hints in place of <code class="docutils literal notranslate"><span class="pre">:rtype</span></code> Sphinx directive</p></li>
+<li><p>Remove unused dependency <code class="docutils literal notranslate"><span class="pre">deprecation</span></code></p></li>
+<li><p>Fix bug: path <code class="docutils literal notranslate"><span class="pre">/tags/{id}/{entity_type}</span></code> breaks entity wrapping logic (<a class="reference external" href="https://github.com/PagerDuty/pdpyras/issues/130">issue #130</a>)</p></li>
+</ul>
+<p><strong>2023-11-15: Version 5.1.3:</strong></p>
+<ul class="simple">
+<li><p>Remove deprecated escape sequences, which were causing downstream linter/unit test errors, from docstrings</p></li>
+<li><p>Remove references to removed properties from the module reference that were causing Sphinx warnings</p></li>
+</ul>
 <p><strong>2023-09-12: Version 5.1.2:</strong></p>
 <ul class="simple">
 <li><p>Address issue <a class="reference external" href="https://github.com/PagerDuty/pdpyras/issues/115">#115</a> by adding default values to <a class="reference internal" href="module_reference.html#pdpyras.PDSession.retry" title="pdpyras.PDSession.retry"><code class="xref py py-attr docutils literal notranslate"><span class="pre">pdpyras.PDSession.retry</span></code></a> for Events and Change Events API client classes</p></li>

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Contribution Guide &#8212; PagerDuty Python REST API Sessions 5.1.3 documentation</title>
+    <title>Contribution Guide &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; PagerDuty Python REST API Sessions 5.1.3 documentation</title>
+    <title>Index &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>PDPYRAS: PagerDuty Python REST API Sessions &#8212; PagerDuty Python REST API Sessions 5.1.3 documentation</title>
+    <title>PDPYRAS: PagerDuty Python REST API Sessions &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>