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
DOC: remove incorrect sentence about subpackage imports #19836
Comments
Hey, I can take this one - Though, to be clear, is the full extent of the change to just remove the incorrect guidance, and update the statement
To be something more like
|
thanks @ShanDeng123 ! TBH I don't think we even need to mention Lazy Loading here - it isn't relevant as one of the first things that users will see in the tutorial. The following sounds good to me:
|
Aye aye - Sounds good! |
I'd much prefer to not see new guidance written indeed. @lucascolley's suggestion in the last comment above is good. In addition, you can link to https://scipy.github.io/devdocs/reference/index.html#guidelines-for-importing-functions-from-scipy. |
Hello, sorry I am new here, but is there already a pull request open for this issue? |
No, feel free to open one! |
if anyone needs help, let me know! I'll be watching |
Made changes in tutorial (user guide) according to the updates pointed out in issue "DOC: remove incorrect sentence about subpackage imports scipy#19836"
Made changes in tutorial (user guide) according to the updates pointed out in issue "DOC: remove incorrect sentence about subpackage imports scipy#19836 [docs only]"
I understand the issue. This is my first time doing it. That's how I did- |
@kru2710shna it looks like there is already an open pr to fix this so it would be best to look at a different issue to avoid duplicating work. Regardless, thank you for your interest in contributing to SciPy. |
Made changes in tutorial (user guide) according to the updates pointed out in issue "DOC: remove incorrect sentence about subpackage imports #19836 [docs only]"
Thanks |
Issue with current documentation:
https://scipy.github.io/devdocs/tutorial/index.html#subpackages says that "SciPy subpackages need to be imported separately". This is no longer true! see https://scientific-python.org/specs/spec-0001/
Idea or request for content:
Remove the incorrect guidance. The lines are
scipy/doc/source/tutorial/index.rst
Lines 43 to 46 in e7c6a0d
Additional context (e.g. screenshots, GIFs)
The text was updated successfully, but these errors were encountered: