docs: deprecate convert - #721
Conversation
jl-wynen
left a comment
jl-wynen
left a comment
There was a problem hiding this comment.
Works for me. @SimonHeybrock do you have an opinion? I seem to remember you being in favour of keeping convert in the past.
| filterwarnings = [ | ||
| "error", | ||
| # Legacy conversion tests intentionally exercise this deprecated API. | ||
| 'ignore:scippneutron.convert is deprecated:scipp.VisibleDeprecationWarning', |
There was a problem hiding this comment.
Can you suppress this in convert_test.py instead of globally? That way, we check that we don't use convert elsewhere on accident.
|
I suppose the question is: Does it cost us anything to keep it? If we deprecate it, should we still keep it around indefinitely (like some projects do)? |
I'd say it costs very little. In principle the codebase will be more difficult to navigate and understand if we have tons of deprecated functionality around, but we're not anywhere near that. Eventually I think we should remove this entirely. But imo we can easily wait 6 months or more to do so. |
jl-wynen
left a comment
jl-wynen
left a comment
There was a problem hiding this comment.
I am fine with merging this.
If we deprecate convert, we should ultimately remove it. Otherwise we teach our users to ignore deprecation warnings.
3 participants
Fixes scipp/ess#9