DOC: Added example for get_printoption, recfromtxt and recfromcsv #22558
Conversation
|
Contributed as a part of PyData NYC 2022 |
|
Thanks @isthatdebbiej. The NumPy docstring standard specifies that the Examples section is the last section of the docstring. Also, it should have the same indentation level as the other sections. Finally--really nitpicky, I know--the section name is Examples, not Example (even if there is, in fact, only one example!). |
|
@WarrenWeckesser Thank you! I have updated it. |
There was a problem hiding this comment.
Thanks @isthatdebbiej . While looking at this I realized that the keys listed in Returns description are actually out-of-date - we should take this opportunity to either update them, or delete them and refer to the examples section which should be tested and thus always up-to-date.
| Examples | ||
| -------- | ||
| np.recfromtxt('data.txt') | ||
|
|
There was a problem hiding this comment.
I suspect these were accidentally included on this branch as they seem unrelated to the printoptions example.
There was a problem hiding this comment.
I also added examples for recfromtxt and recfromcsv. Should I create a new PR for that? Or update the PR title?
There was a problem hiding this comment.
@isthatdebbiej In this case, updating the PR title and description will work.
It is recommended though opening a separate PR for each task.
|
I think we should close this. The examples do not add that much information. |
Thanks @mattip . I had intended to try to expand on these examples a bit but since the PR originates from
|
No description provided.