🎨 Naming improvements #59
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nquetschlich
added
documentation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=====================================
Coverage 97.8% 97.8%
=====================================
Files 5 5
Lines 94 94
=====================================
Hits 92 92
Misses 2 2
☔ View full report in Codecov by Sentry. |
tobi-forster
pushed a commit
that referenced
this pull request
May 15, 2025
Updates the requirements on [numpy](https://github.com/numpy/numpy) and [sphinx](https://github.com/sphinx-doc/sphinx) to permit the latest version. Updates `numpy` to 2.0.1 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/numpy/numpy/releases">numpy's releases</a>.</em></p> <blockquote> <h2>v2.0.1</h2> <h1>NumPy 2.0.1 Release Notes</h1> <p>NumPy 2.0.1 is a maintenance release that fixes bugs and regressions discovered after the 2.0.0 release. NumPy 2.0.1 is the last planned release in the 2.0.x series, 2.1.0rc1 should be out shortly.</p> <p>The Python versions supported by this release are 3.9-3.12.</p> <p><strong><em>NOTE:</em></strong> Do not use the GitHub generated "Source code" files listed in the "Assets", they are garbage.</p> <h2>Improvements</h2> <h3><code>np.quantile</code> with method <code>closest_observation</code> chooses nearest even order statistic</h3> <p>This changes the definition of nearest for border cases from the nearest odd order statistic to nearest even order statistic. The numpy implementation now matches other reference implementations.</p> <p>(<a href="https://redirect.github.com/numpy/numpy/pull/26656">gh-26656</a>)</p> <h2>Contributors</h2> <p>A total of 15 people contributed to this release. People with a "+" by their names contributed a patch for the first time.</p> <ul> <li><a href="https://github.com/vahidmech"><code>@vahidmech</code></a> +</li> <li>Alex Herbert +</li> <li>Charles Harris</li> <li>Giovanni Del Monte +</li> <li>Leo Singer</li> <li>Lysandros Nikolaou</li> <li>Matti Picus</li> <li>Nathan Goldbaum</li> <li>Patrick J. Roddy +</li> <li>Raghuveer Devulapalli</li> <li>Ralf Gommers</li> <li>Rostan Tabet +</li> <li>Sebastian Berg</li> <li>Tyler Reddy</li> <li>Yannik Wicke +</li> </ul> <h2>Pull requests merged</h2> <p>A total of 24 pull requests were merged for this release.</p> <ul> <li><a href="https://redirect.github.com/numpy/numpy/pull/26711">#26711</a>: MAINT: prepare 2.0.x for further development</li> <li><a href="https://redirect.github.com/numpy/numpy/pull/26792">#26792</a>: TYP: fix incorrect import in <code>ma/extras.pyi</code> stub</li> <li><a href="https://redirect.github.com/numpy/numpy/pull/26793">#26793</a>: DOC: Mention '1.25' legacy printing mode in <code>set_printoptions</code></li> <li><a href="https://redirect.github.com/numpy/numpy/pull/26794">#26794</a>: DOC: Remove mention of NaN and NAN aliases from constants</li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/numpy/numpy/commit/4c9f4316aaf8e80d9d18f089d1267d9cd74d0192"><code>4c9f431</code></a> Merge pull request <a href="https://redirect.github.com/numpy/numpy/issues/27000">#27000</a> from charris/prepare-2.0.1</li> <li><a href="https://github.com/numpy/numpy/commit/0e70e003121b4530fd32294f5cf953b1b400dcc7"><code>0e70e00</code></a> REL: Prepare for the NumPy 2.0.1 release [wheel build]</li> <li><a href="https://github.com/numpy/numpy/commit/4d10ffcaab66ce47fc730034858cba9a95b359ce"><code>4d10ffc</code></a> Merge pull request <a href="https://redirect.github.com/numpy/numpy/issues/26995">#26995</a> from charris/backport-26985</li> <li><a href="https://github.com/numpy/numpy/commit/764b6674912542b7b89d6faf0394e10049ed91d0"><code>764b667</code></a> BUG: Add object cast to avoid warning with limited API</li> <li><a href="https://github.com/numpy/numpy/commit/9be6ad64c03ce91395fc3f6ee8d25f5e09174869"><code>9be6ad6</code></a> Merge pull request <a href="https://redirect.github.com/numpy/numpy/issues/26971">#26971</a> from charris/backport-26935</li> <li><a href="https://github.com/numpy/numpy/commit/6d950e9af15d52c47f8e31141b206808fd665b72"><code>6d950e9</code></a> BUG: fix f2py tests to work with v2 API</li> <li><a href="https://github.com/numpy/numpy/commit/89630c07a7c2af19c719453f6839ee7e009ed90d"><code>89630c0</code></a> Merge pull request <a href="https://redirect.github.com/numpy/numpy/issues/26962">#26962</a> from charris/backport-26919</li> <li><a href="https://github.com/numpy/numpy/commit/88fa84092921dd5f9f41d680ca2b00aedf4ab40e"><code>88fa840</code></a> TST: Apply test suggestion by Nathan for rlstrip fixes</li> <li><a href="https://github.com/numpy/numpy/commit/a9da01e11717f83bcb96a01d1ebed132f3cb938d"><code>a9da01e</code></a> BUG,MAINT: Fix utf-8 character stripping memory access</li> <li><a href="https://github.com/numpy/numpy/commit/6afbbf8f3c8efa3c5c480e922a4904821e43812a"><code>6afbbf8</code></a> Merge pull request <a href="https://redirect.github.com/numpy/numpy/issues/26963">#26963</a> from charris/backport-26930</li> <li>Additional commits viewable in <a href="https://github.com/numpy/numpy/compare/v1.26.4...v2.0.1">compare view</a></li> </ul> </details> <br /> Updates `sphinx` to 8.0.2 <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/sphinx-doc/sphinx/releases">sphinx's releases</a>.</em></p> <blockquote> <h2>Sphinx 8.0.2</h2> <p>Changelog: <a href="https://www.sphinx-doc.org/en/master/changes.html">https://www.sphinx-doc.org/en/master/changes.html</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/sphinx-doc/sphinx/blob/v8.0.2/CHANGES.rst">sphinx's changelog</a>.</em></p> <blockquote> <h1>Release 8.0.2 (released Jul 30, 2024)</h1> <h2>Bugs fixed</h2> <ul> <li>Fix the <code>pygments.Formatter.__class_getitem__</code> patch. Patch by Adam Turner.</li> </ul> <h1>Release 8.0.1 (released Jul 30, 2024)</h1> <h2>Bugs fixed</h2> <ul> <li>Patch <code>pygments.Formatter.__class_getitem__</code> in Pygments 2.17. Patch by Adam Turner.</li> </ul> <h1>Release 8.0.0 (released Jul 29, 2024)</h1> <h2>Dependencies</h2> <ul> <li><a href="https://redirect.github.com/sphinx-doc/sphinx/issues/12633">#12633</a>: Drop Python 3.9 support.</li> </ul> <h2>Incompatible changes</h2> <p>.. rst-class:: compact</p> <ul> <li> <p>Remove deprecated functions from <code>sphinx.util</code>:</p> <ul> <li>Removed <code>sphinx.util.path_stabilize</code> (use <code>sphinx.util.osutil.path_stabilize</code>).</li> <li>Removed <code>sphinx.util.display_chunk</code> (use <code>sphinx.util.display.display_chunk</code>).</li> <li>Removed <code>sphinx.util.status_iterator</code> (use <code>sphinx.util.display.status_iterator</code>).</li> <li>Removed <code>sphinx.util.SkipProgressMessage</code> (use <code>sphinx.util.display.SkipProgressMessage</code>).</li> <li>Removed <code>sphinx.util.progress_message</code> (use <code>sphinx.util.display.progress_message</code>).</li> <li>Removed <code>sphinx.util.epoch_to_rfc1123</code> (use <code>sphinx.http_date.epoch_to_rfc1123</code>).</li> <li>Removed <code>sphinx.util.rfc1123_to_epoch</code> (use <code>sphinx.http_date.rfc1123_to_epoch</code>).</li> <li>Removed <code>sphinx.util.save_traceback</code> (use <code>sphinx.exceptions.save_traceback</code>).</li> <li>Removed <code>sphinx.util.format_exception_cut_frames</code></li> </ul> </li> </ul> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/sphinx-doc/sphinx/commit/043750e406d8fe03953f5b565b36e05aef6866ec"><code>043750e</code></a> Bump to 8.0.2 final</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/cee9efc0ab3068e05a853ffb27c82ada869372fe"><code>cee9efc</code></a> Use <code>classmethod</code> for a class method</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/16fed3576ca76ebdbc5cfe3eada743fb4fff7928"><code>16fed35</code></a> Bump version</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/d9bda77b79b054dc19aec679b179d8b8eaf6e165"><code>d9bda77</code></a> Bump to 8.0.1 final</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/006a6a7fcf680bed229dbb58bdda1af06dd68d87"><code>006a6a7</code></a> Fix Flake8</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/d0915ab25b7214ca6441a6bb93fe1f939d915237"><code>d0915ab</code></a> Fix mypy</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/865b513cf2c88d3e30450718914aa896d90fd14e"><code>865b513</code></a> Patch <code>pygments.Formatter.__class_getitem__</code> in Pygments 2.17</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/f1d3c3f465b7239bf0f34de8e5b80e694c1474e2"><code>f1d3c3f</code></a> Bump version</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/0e8a6383be58ed1528c26a924abb73c0b4672e69"><code>0e8a638</code></a> Bump to 8.0.0 final</li> <li><a href="https://github.com/sphinx-doc/sphinx/commit/5750d0e3fe8905fb582a6db95512f28b4c26159e"><code>5750d0e</code></a> [bot]: Update message catalogues (<a href="https://redirect.github.com/sphinx-doc/sphinx/issues/12641">#12641</a>)</li> <li>Additional commits viewable in <a href="https://github.com/sphinx-doc/sphinx/compare/v7.0.0...v8.0.2">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself) - `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself) - `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself) - `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency - `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Lukas Burgholzer <burgholzer@me.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.