DOC: added example in char #22500
DOC: added example in char #22500
Conversation
| >>> np.char.add(["num", "doc"], ["py", "umentation"]) | ||
| array(['numpy', 'documentation'], dtype='<U13') | ||
|
|
||
| The methods in this module are based on the methods in :py:mod:`String` |
There was a problem hiding this comment.
alternatively: These methods are based on :py:mod:`String`
There was a problem hiding this comment.
I think the examples won't fit on this page... As each method has its own page (when you click on hyperlinks - https://numpy.org/devdocs/reference/routines.char.html)
For example numpy.char.capitalize already has an example listed on its doc page - https://numpy.org/devdocs/reference/generated/numpy.char.capitalize.html
May be adding examples to each method separately is a good idea to maintain consistency.
There was a problem hiding this comment.
You can shift the example for np.char.add into
numpy/numpy/core/defchararray.py
Lines 297 to 322 in 04ddeb3
|
Yeah I wasn't intending to post examples of every method on the intro page, just the two to give high level examples of how this module works. I can though also go in and give examples on every page if that would be preferred |
I agree, but to keep the documentation consistent, I suggested it to be in individual pages (essentially functions)
That sounds good! It is also a good idea to have examples in all functions! |
So I thought that there were more pages before I opened this PR (sorry my mistake), but the library isn't 100% consistent about this: |
Agreed. Then the version you have now makes sense as well (do add "more examples are in the functions" sentence as in the link you have shared), but I would still suggest adding the example also in the function which will be more helpful. |
Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
|
@rossbar and @pranaymodukuru should I open an issue about a followup adding examples to the char methods? Also @rossbar do you all do squash merge or is the preference that I rebase? |
I usually squash-merge, so no need to worry about rebasing!
There are already several tracking issues open about docstrings missing examples, e.g. #21351 (comment) (on which |
|
Not having to track it down myself sounds awesome! 😅 Also thanks for merging! |
Added small examples to String Operations: np.char because honestly I was having trouble parsing the very clear and consistent signatures and had to double check with geeksforgeeks
Um I'm also not actually sure how I can check the docs on .gitpod, tips would be much appreciated.