Commit
1 year ago
gh-37807: Added some documentation in the developer's guide regarding deprecation In PR #37721, I attempted to deprecate the ``ring`` keyword argument in the ``matrix`` constructor using ``@rename_keyword`` documented [here](https://doc.sagemath.org/htm l/en/developer/coding_in_python.html#deprecation). It did not work. The code compiled exactly as if the decorator wasn't there. I asked @mkoeppe why, he answered it "would be worth investigating and documenting". After some investigation, I came to the conclusion that developers cannot use ``@rename_keyword`` and other such decorators in Cython files. My solution was to use ``deprecation_cython`` (this was accepted and merged). Since many other developers might end up having the exact same problem, I simply suggest redirecting them to ``deprecation_cython``, by adding what's necessary in the docs. In this regard, I added a paragraph mentioning this in the Developer's guide, as all of this was **totally absent** from documentation. This way other developers won't need to investigate and spend time debugging non-working code. :) <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> ### :memo: Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### :hourglass: Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: https://github.com/sagemath/sage/pull/37807 Reported by: SandwichGouda Reviewer(s): Matthias Köppe
Author
Release Manager
Loading