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: Add notes to explain constrains on overwrite_<> #8276

Merged
merged 3 commits into from Feb 28, 2018

Conversation

@APwhitehat
Copy link
Contributor

commented Jan 9, 2018

Doc: Explain constraints on overwrite option in linalg.blas & linalg.lapack.
Fixes #5739 .

@ilayn

This comment has been minimized.

Copy link
Member

commented Jan 9, 2018

@APwhitehat Thanks for the PR. I've completely forgotten about this.

I think a warning is too strong here since the keywords are named as overwrite_<...>. Also we would need some more explanation why f2py behavior is as such.

@APwhitehat APwhitehat force-pushed the APwhitehat:scipy-5739 branch from 14a62b6 to 670538c Jan 9, 2018

@APwhitehat

This comment has been minimized.

Copy link
Contributor Author

commented Jan 9, 2018

@ilayn Made more elaborate, add link to f2py doc.

@ilayn

This comment has been minimized.

Copy link
Member

commented Jan 12, 2018

@APwhitehat

This comment has been minimized.

Copy link
Contributor Author

commented Jan 12, 2018

@ilayn Upon probing I have found that this is a result of using sphinx 1.5.5
This has been fixed in 1.6.6 #3769
This is why It links the docs correctly on my system. (with sphinx 1.6.6)

@ilayn

This comment has been minimized.

Copy link
Member

commented Jan 17, 2018

Welcome to the world of constantly worrying about backwards compatibility 😃

@ilayn

This comment has been minimized.

Copy link
Member

commented Feb 26, 2018

@APwhitehat I've reworded the BLAS file to make the text a bit more self contained. Would you please check and also apply to LAPACK version?

I didn't know which part of f2py you wanted to link to so I think for now we can live with a hard coded hyper link.

@APwhitehat

This comment has been minimized.

Copy link
Contributor Author

commented Feb 27, 2018

@ilayn Thanks.
Your explanation seems complete to me.
I wanted to link this, but it's not required now.
Also we'll need squash merge on this one. :P

@APwhitehat APwhitehat changed the title DOC: Explain constraints on overwrite option DOC: Add notes to explain constrains on overwrite_<> Feb 27, 2018

@ilayn

This comment has been minimized.

Copy link
Member

commented Feb 27, 2018

If anyone else wants to check this is how the new note window renders https://5798-1460385-gh.circle-artifacts.com/0/home/ubuntu/scipy/doc/build/html-scipyorg/linalg.lapack.html

@ilayn ilayn merged commit 5b71f21 into scipy:master Feb 28, 2018

4 checks passed

ci/circleci Your tests passed on CircleCI!
Details
codecov/project 75.86% (target 1%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@ilayn

This comment has been minimized.

Copy link
Member

commented Feb 28, 2018

Thanks @APwhitehat !

@ilayn ilayn added this to the 1.1.0 milestone Feb 28, 2018

@APwhitehat APwhitehat deleted the APwhitehat:scipy-5739 branch Feb 28, 2018

adbugger added a commit to adbugger/scipy that referenced this pull request Mar 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.