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.

Sign up for GitHub

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

Jump to bottom

DOC: optimize: linprog docstring has two "Returns" sections #3905

Closed
WarrenWeckesser opened this issue Aug 26, 2014 · 1 comment
Closed

DOC: optimize: linprog docstring has two "Returns" sections #3905

WarrenWeckesser opened this issue Aug 26, 2014 · 1 comment
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected 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 scipy.optimize
Milestone
0.15.0

Comments

@WarrenWeckesser
Copy link
Member

The docstring for linprog (in https://github.com/scipy/scipy/blob/master/scipy/optimize/_linprog.py) needs some work. It has two "Returns" sections, and order of the other sections does not following the docstring standard (https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
@WarrenWeckesser WarrenWeckesser added this to the 0.15.0 milestone Aug 26, 2014
@venthur
Copy link
Contributor

venthur commented Aug 31, 2014

working on it

@ev-br ev-br closed this as completed in 678149b Aug 31, 2014
ev-br added a commit that referenced this issue Aug 31, 2014
@ev-br
Merge pull request #3922 from venthur/fix-3905
d6f85ca 
DOC: fix docstring issues in linprog (Fixes #3905).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected 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 scipy.optimize
Projects
None yet
Milestone
0.15.0
Development

No branches or pull requests
3 participants
@rgommers @venthur @WarrenWeckesser