Fwd: [scipy/scipy] Move misc.doccer to _lib.doccer (#9652)
Hi, As a part of an ongoing cleanup of scipy.misc namespace, here's a PR https://github.com/scipy/scipy/pull/9652 to deprecate scipy.misc.doccer module. With this PR, - the module itself is moved to scipy._lib.doccer, and all internal uses import from scipy._lib. - imports from scipy.misc.doccer emit DeprecationWarnings for now, and will stop working in a(yet unspecified) future release. The recommendation for the user code which uses `import scipy.misc.doccer` is to copy-paste the doccer.py file into your project. Thoughts? Cheers, Evgeni ---------- Forwarded message --------- From: Ralf Gommers <notifications@github.com> Date: Sat, Jan 5, 2019 at 9:06 AM Subject: Re: [scipy/scipy] Move misc.doccer to _lib.doccer (#9652) To: scipy/scipy <scipy@noreply.github.com> Cc: Evgeni Burovski <evgeny.burovskiy@gmail.com>, Author < author@noreply.github.com> +1 for this deprecation. Could you propose it on the mailing list though? I doubt there's many users, but nevertheless we should propose all deprecations there. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://github.com/scipy/scipy/pull/9652#issuecomment-451631143>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACCPSBCjzQVCq5kIzQjH178eR1...> .
On Sat, Jan 5, 2019 at 8:17 AM Evgeni Burovski <evgeny.burovskiy@gmail.com> wrote:
Hi,
As a part of an ongoing cleanup of scipy.misc namespace, here's a PR https://github.com/scipy/scipy/pull/9652 to deprecate scipy.misc.doccer module. With this PR, - the module itself is moved to scipy._lib.doccer, and all internal uses import from scipy._lib. - imports from scipy.misc.doccer emit DeprecationWarnings for now, and will stop working in a(yet unspecified) future release.
The recommendation for the user code which uses `import scipy.misc.doccer` is to copy-paste the doccer.py file into your project. Thoughts?
That recommendation seems reasonable. It's not really SciPy's job to provide docstring formatting utilities. Cheers, Ralf
Cheers,
Evgeni
---------- Forwarded message --------- From: Ralf Gommers <notifications@github.com> Date: Sat, Jan 5, 2019 at 9:06 AM Subject: Re: [scipy/scipy] Move misc.doccer to _lib.doccer (#9652) To: scipy/scipy <scipy@noreply.github.com> Cc: Evgeni Burovski <evgeny.burovskiy@gmail.com>, Author < author@noreply.github.com>
+1 for this deprecation. Could you propose it on the mailing list though? I doubt there's many users, but nevertheless we should propose all deprecations there.
— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <https://github.com/scipy/scipy/pull/9652#issuecomment-451631143>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ACCPSBCjzQVCq5kIzQjH178eR1...> . _______________________________________________ SciPy-Dev mailing list SciPy-Dev@python.org https://mail.python.org/mailman/listinfo/scipy-dev
participants (2)
-
Evgeni Burovski -
Ralf Gommers