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

add docs for ldexp and frexp (Trac #1759) #2354

Closed
numpy-gitbot opened this issue Oct 19, 2012 · 2 comments · Fixed by #4400
Closed

add docs for ldexp and frexp (Trac #1759) #2354

numpy-gitbot opened this issue Oct 19, 2012 · 2 comments · Fixed by #4400
Labels
00 - Bug component: documentation

Comments

@numpy-gitbot
Copy link

Original ticket http://projects.scipy.org/numpy/ticket/1759 on 2011-03-07 by @rgommers, assigned to @pv.

The ldexp and frexp docstrings are out of date. It's not clear to me if entries have to be added to core/code_generators/generate_umath.py, or it has to be done in the C source directly.
@numpy-gitbot
Copy link
Author

Milestone changed to Unscheduled by @rgommers on 2011-03-30

@ewmoore ewmoore mentioned this issue Aug 30, 2013
Closed
@charris
Copy link
Member

charris commented Feb 17, 2014

Looks like numpy/core/code_generators/ufunc_docstrings.py is the place. There is some nice documentation in add_newdocs.py that should be copied over. The functions are also documented in umathmodlule.c, that can probably be removed.

charris added a commit to charris/numpy that referenced this issue Mar 1, 2014
@charris
DOC: Document ldexp and frexp.
6bfd6d4 
The documentation needs to be in umathmodule.c as that is where ldexp
and frexp and defined. I moved the current documention from
add_newdocs.py to ufunc_docstrings.py, manually translated them into C
strings, and inserted them into umathmodule.c.

Closes numpy#2354.
@charris charris mentioned this issue Mar 1, 2014
Merged
charris added a commit to charris/numpy that referenced this issue Mar 1, 2014
@charris
DOC: Document ldexp and frexp.
7949c68 
The documentation needs to be in umathmodule.c as that is where ldexp
and frexp and defined. I moved the current documention from
add_newdocs.py to ufunc_docstrings.py, manually translated them into C
strings, and inserted them into umathmodule.c.

Closes numpy#2354.
@charris charris mentioned this issue Mar 1, 2014
Merged
charris added a commit to charris/numpy that referenced this issue Mar 1, 2014
@charris
DOC: Update 1.8.1 release notes.
e3e92f2 
This adds the documentation fixes.

numpygh-3563
numpygh-2354
numpygh-2807
numpygh-2423
@charris charris mentioned this issue Mar 1, 2014
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
00 - Bug component: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix ufunc documention charris/numpy
2 participants
@charris @numpy-gitbot