-
Notifications
You must be signed in to change notification settings - Fork 302
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Broken backwards compatibility #107
Comments
Thanks for the deprecation/warning suggestion. I'll do that before a major version change next time. I do change function names to be consistent with coding conventions to make things easier for me to write and maintain. |
This is really an issue for me, Due to lack of backward compatibility, I have to repair few stuff to get along with new version. But I believe, In future, This updated version will save us from many bugs 1.3.9 had and gives much more flexibility. Thanks |
This is an open source project with only a single major contributor, be happy to already have something that works quite fine! It's not like it has 10 active contributors that work full time on this. It is maybe not perfect but if you don't want to have to repair stuff at every update, just stay with the version that works for you. If new features are available in a more recent version and API changes breaks your code that's because we needed to change the API. About the deprecation/warning, it is fine for really big projects where you have a schedule for the development etc but in the real life with such small packages when you have an idea to improve the code you develop it in like an afternoon and you don't have the time to create a new release just to add warnings. You can also pip install from commits if you want to update to specific commits that fix your problems (https://stackoverflow.com/questions/13685920/install-specific-git-commit-with-pip). |
…ocs (#477) Bumps [readthedocs-sphinx-search](https://github.com/readthedocs/readthedocs-sphinx-search) from 0.1.1 to 0.3.2. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/readthedocs/readthedocs-sphinx-search/blob/main/CHANGELOG.rst">readthedocs-sphinx-search's changelog</a>.</em></p> <blockquote> <h2>Version 0.3.2</h2> <p>:Date: Jan 15, 2024</p> <ul> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Security fix, more information in <code>GHSA-xgfm-fjx6-62mj <https://github.com/readthedocs/readthedocs-sphinx-search/security/advisories/GHSA-xgfm-fjx6-62mj></code>__.</li> </ul> <h2>Version 0.3.1</h2> <p>:Date: Mar 27, 2023</p> <ul> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Add missing static file (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/135">#135</a>)</li> </ul> <h2>Version 0.3.0</h2> <p>:Date: Mar 27, 2023</p> <ul> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Use the search API V3 and add support for custom filters (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/132">#132</a>)</li> </ul> <h2>Version 0.2.0</h2> <p>:Date: Jan 24, 2023</p> <p>This version adds support for sphinx 6.x, and makes JQuery optional for animations.</p> <ul> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: CI: fix tests (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/127">#127</a>)</li> <li><a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot]: Bump decode-uri-component from 0.2.0 to 0.2.2 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/120">#120</a>)</li> <li><a href="https://github.com/dependabot"><code>@dependabot</code></a>[bot]: Bump minimatch and gulp (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/119">#119</a>)</li> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Refactor: don't depend on underscore.js (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/116">#116</a>)</li> <li><a href="https://github.com/stsewd"><code>@stsewd</code></a>: Remove usage of jquery (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/115">#115</a>)</li> </ul> <h2>Version 0.1.2</h2> <p>:Date: May 11, 2022</p> <ul> <li><code>@ericholscher <https://github.com/ericholscher></code><strong>: Improve SEO of README & docs index (<code>[#111](readthedocs/readthedocs-sphinx-search#111) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/111></code></strong>)</li> <li><code>@dependabot[bot] <https://github.com/dependabot[bot]></code><strong>: Bump moment from 2.29.1 to 2.29.2 (<code>[#110](readthedocs/readthedocs-sphinx-search#110) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/110></code></strong>)</li> <li><code>@stsewd <https://github.com/stsewd></code><strong>: Test with sphinx 4 and python 3.10 (<code>[#109](readthedocs/readthedocs-sphinx-search#109) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/109></code></strong>)</li> <li><code>@stsewd <https://github.com/stsewd></code><strong>: Add sphinx metadata (<code>[#108](readthedocs/readthedocs-sphinx-search#108) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/108></code></strong>)</li> <li><code>@dependabot[bot] <https://github.com/dependabot[bot]></code><strong>: Bump minimist from 1.2.5 to 1.2.6 (<code>[#107](readthedocs/readthedocs-sphinx-search#107) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/107></code></strong>)</li> <li><code>@stsewd <https://github.com/stsewd></code><strong>: Rename master -> main (<code>[#106](readthedocs/readthedocs-sphinx-search#106) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/106></code></strong>)</li> <li><code>@stsewd <https://github.com/stsewd></code><strong>: Docs: use sphinx 4.x (<code>[#105](readthedocs/readthedocs-sphinx-search#105) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/105></code></strong>)</li> <li><code>@astrojuanlu <https://github.com/astrojuanlu></code><strong>: Fix docs (<code>[#102](readthedocs/readthedocs-sphinx-search#102) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/102></code></strong>)</li> <li><code>@dependabot[bot] <https://github.com/dependabot[bot]></code><strong>: Bump postcss from 7.0.35 to 7.0.39 (<code>[#100](readthedocs/readthedocs-sphinx-search#100) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/100></code></strong>)</li> <li><code>@dependabot[bot] <https://github.com/dependabot[bot]></code><strong>: Bump path-parse from 1.0.6 to 1.0.7 (<code>[#99](readthedocs/readthedocs-sphinx-search#99) <https://github.com/readthedocs/readthedocs-sphinx-search/pull/99></code></strong>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/c485b81f6015e4867bb01e600d031dc402500b39"><code>c485b81</code></a> Release 0.3.2</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/8c6f6d01e88e72ef32ed0c220b6c19d1e1121c73"><code>8c6f6d0</code></a> Merge pull request from GHSA-xgfm-fjx6-62mj</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/1608743622df0883b785a2ce07c587f146f2102b"><code>1608743</code></a> Release 0.3.1 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/136">#136</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/25673a35b661a6a5dbc82d26c44998028dd61cc0"><code>25673a3</code></a> Release 0.3.0 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/135">#135</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/ca36a1566296fe79926e838d9771ec0b7a1a27a8"><code>ca36a15</code></a> Use API V3 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/132">#132</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/c8cb91264db65ff64f93d9cdf95eec75159f2ea1"><code>c8cb912</code></a> Release 0.2.0 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/128">#128</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/5432999e4689970f22275c833aa65e41e4f8b1e3"><code>5432999</code></a> CI: fix tests (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/127">#127</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/fa7e607f98bd697f9b4b6af6d3cd7de6d5e39117"><code>fa7e607</code></a> Bump decode-uri-component from 0.2.0 to 0.2.2 (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/120">#120</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/225353f6be04f2fa178ec2350e3c27599b6b2ea1"><code>225353f</code></a> Refactor: don't depend on underscore.js (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/116">#116</a>)</li> <li><a href="https://github.com/readthedocs/readthedocs-sphinx-search/commit/5880a64bc514fef99a083c40f2dadc3e939cdc88"><code>5880a64</code></a> Remove usage of jquery (<a href="https://redirect.github.com/readthedocs/readthedocs-sphinx-search/issues/115">#115</a>)</li> <li>Additional commits viewable in <a href="https://github.com/readthedocs/readthedocs-sphinx-search/compare/0.1.1...0.3.2">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=readthedocs-sphinx-search&package-manager=pip&previous-version=0.1.1&new-version=0.3.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 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 this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/MIT-LCP/wfdb-python/network/alerts). </details>
Just wanted to let you know that the new version of package has broken backwards compatibility. I do realize that this is a major bump in version (2.0.1, compared to previous 1.3.9), but there was no warning this would happen, as far as I can remember.
There were no deprecations, no warnings. In the new version some functions are gone, to be replaced by other. And those aren't even big changes, but rather functions changing name (from API perspective at least).
It's not a big issue really, just an inconvenience. I just want to give you some feedback. You could save people some time by just deprecating old functions first. Or don't just go around changing functions' names when there's no real need for that.
The text was updated successfully, but these errors were encountered: