Opened 6 years ago
Closed 6 years ago
#17038 closed enhancement (fixed)
deprecated_callable_import should mention the deprecation in __doc__
Reported by: | ncohen | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-6.4 |
Component: | misc | Keywords: | |
Cc: | tscrim, vbraun, wstein | Merged in: | |
Authors: | Nathann Cohen | Reviewers: | Punarbasu Purkayastha |
Report Upstream: | N/A | Work issues: | |
Branch: | 869953f (Commits) | Commit: | 869953f280c819912ed56d44e8c22517a8b732b4 |
Dependencies: | Stopgaps: |
Description
With this branch, the doc of WittDesign
changes from:
INPUT: * "n" is in 9,10,11,12,21,22,23,24. Wraps GAP Design's WittDesign. If "n=24" then this function returns the large Witt design W_{24}, the unique (up to isomorphism) ...
to
This method soon will not be available in that way anymore. To use it, you can now call it by typing designs.WittDesign
Related sage-devel thread at https://groups.google.com/d/topic/sage-devel/tD8tHOp3q1I/discussion
Nathann
Change History (7)
comment:1 Changed 6 years ago by
- Branch set to u/ncohen/17038
- Status changed from new to needs_review
comment:2 Changed 6 years ago by
- Commit set to 869953f280c819912ed56d44e8c22517a8b732b4
comment:3 Changed 6 years ago by
Is there a way to do something similar for functions like sage.coding.code_constructions.cyclotomic_cosets
? Otherwise, the patch looks good to me.
comment:4 Changed 6 years ago by
Hmmmm.. There is something called deprecated_function_alias
but it does not work when the arguments are not the same. For this, we would need a decorator to deprecate a function with a given warning.
Nathann
comment:5 Changed 6 years ago by
- Reviewers set to Punarbasu Purkayastha
- Status changed from needs_review to positive_review
Never mind. The deprecation is already mentioned in the docstring of the function. Outlying examples such as this can be dealt with in their individual tickets.
comment:6 Changed 6 years ago by
Thanks !
comment:7 Changed 6 years ago by
- Branch changed from u/ncohen/17038 to 869953f280c819912ed56d44e8c22517a8b732b4
- Resolution set to fixed
- Status changed from positive_review to closed
Branch pushed to git repo; I updated commit sha1. New commits:
trac #17038: deprecated_callable_import should mention the deprecation in __doc__