Skip to content
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

Closed
lucascolley opened this issue Jan 8, 2024 · 10 comments · Fixed by #19929
Closed

DOC: remove incorrect sentence about subpackage imports #19836

lucascolley opened this issue Jan 8, 2024 · 10 comments · Fixed by #19929
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Milestone

Comments

@lucascolley
Copy link
Member

lucascolley commented Jan 8, 2024

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 subpackages need to be imported separately, for example::
>>> from scipy import linalg, optimize

Additional context (e.g. screenshots, GIFs)

image

@lucascolley lucascolley added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution labels Jan 8, 2024
@lucascolley lucascolley added this to the 1.13.0 milestone Jan 8, 2024
@ShanDeng123
Copy link

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

SciPy is organized into subpackages covering different scientific computing domains. These are summarized in the following table:

To be something more like

SciPy is organized into subpackages covering different scientific computing domains. SciPy subpackages can be utilized directly via Lazy Loading, and are summarized in the following table:

@lucascolley
Copy link
Member Author

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:

SciPy is organized into subpackages covering different scientific computing domains, which are summarized in the following table:

@ShanDeng123
Copy link

Aye aye - Sounds good!

@rgommers
Copy link
Member

rgommers commented Jan 9, 2024

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.

@rgommers rgommers changed the title DOC: remove incorrect guidance since SPEC 1 DOC: remove incorrect sentence about subpackage imports Jan 10, 2024
@aadityab7
Copy link
Contributor

Hello, sorry I am new here, but is there already a pull request open for this issue?

@lucascolley
Copy link
Member Author

Hello, sorry I am new here, but is there already a pull request open for this issue?

No, feel free to open one!

@tactipus
Copy link

if anyone needs help, let me know! I'll be watching

aadityab7 added a commit to aadityab7/scipy that referenced this issue Jan 21, 2024
Made changes in tutorial (user guide) according to the updates pointed out in issue "DOC: remove incorrect sentence about subpackage imports scipy#19836"
aadityab7 added a commit to aadityab7/scipy that referenced this issue Jan 21, 2024
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]"
@kru2710shna
Copy link

I understand the issue.

This is my first time doing it. That's how I did-
Fork the repo.
clone the repo
and do I need to follow this https://scipy.github.io/devdocs/dev/dev_quickstart.html ??

@j-bowhay
Copy link
Member

j-bowhay commented Feb 5, 2024

@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.

lucascolley pushed a commit that referenced this issue Mar 2, 2024
Made changes in tutorial (user guide) according to the updates pointed out in issue "DOC: remove incorrect sentence about subpackage imports #19836
[docs only]"
@kru2710shna
Copy link

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants