Skip to content

DOC: fromnumeric.py - list of functions that are missing examples – tracking issue #22266

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
Closed
9 of 16 tasks
InessaPawson opened this issue Sep 16, 2022 · 12 comments
Closed
9 of 16 tasks

DOC: fromnumeric.py - list of functions that are missing examples – tracking issue #22266

InessaPawson opened this issue Sep 16, 2022 · 12 comments
Labels
04 - Documentation sprintable Issue fits the time-frame and setting of a sprint

Comments

@InessaPawson
Copy link
Member

InessaPawson commented Sep 16, 2022 •
edited
Loading

Find below the functions from fromnumeric.py that are missing examples in the docstrings. If you have a suggestion for an example, please submit a pull request.
To let everyone know that there is work in progress, link your PR to this issue. (If needed, refer to the GitHub documentation on how to do it.)

  • alltrue (alias)
  • copyto
  • diag_indices_from
  • get_array_wrap (deprecated in API: deprecate undocumented functions #24154)
  • get_include
  • get_printoptions
  • getbufsize (requires experimenting and understanding its effect)
  • msort (technically an alias)
  • product
  • recfromcsv
  • recfromtxt
  • round_ (alias)
  • setbufsize (see getbufsize)
  • sometrue (alias)
  • tril_indices_from
  • triu_indices_from

IMPORTANT: Don't close this issue or remove the "sprintable" label until all the PRs with examples are merged.
@InessaPawson InessaPawson added 04 - Documentation sprintable Issue fits the time-frame and setting of a sprint labels Sep 16, 2022
@InessaPawson InessaPawson changed the title DOC: fromnumeric.py - list of functions that are missing examples – tracking issue DOC: fromnumeric.py - list of functions that are missing examples – tracking issue Sep 16, 2022
@simranmakandar
Copy link
Contributor

I am giving this a shot as part of OSD @ GHC 2022

@sanjanamm98
Copy link
Contributor

Looking into product function as part of the Grace Hopper OSD NumPy sprint

@dg3192
Copy link
Contributor

dg3192 commented Sep 16, 2022 •
edited
Loading

I am giving this a shot as part of OSD @ GHC 2022
-- copy to example added - Pr #22292

@pavani34
Copy link

I am giving this a try as part of OSD @ GHC 2022

@shreya-singh-tech
Copy link
Contributor

shreya-singh-tech commented Sep 16, 2022 •
edited
Loading

Looking into this as part of the Grace Hopper OSD NumPy sprint
--update 1 : msort example added PR : #22279

@shreya-singh-tech shreya-singh-tech mentioned this issue Sep 16, 2022
Merged
@isthatdebbiej
Copy link

isthatdebbiej commented Nov 8, 2022 •
edited
Loading

So thrilled to be contributing as a part of PyData NYC Sprint 2022.
PR for get_printoptions, recfromcsv and recfromtxt: 22558

@richierocks richierocks mentioned this issue Nov 8, 2022
Merged
nelehuvaere added a commit to nelehuvaere/numpy that referenced this issue Nov 8, 2022
@nelehuvaere
issue numpy#22266 parameters, returns, examples for alltrue
9fb4c44
richierocks added a commit to richierocks/numpy that referenced this issue Nov 8, 2022
@richierocks
DOC: numpy#22266 add examples for tril_indices_from()
562ad0c
richierocks added a commit to richierocks/numpy that referenced this issue Nov 8, 2022
@richierocks
DOC: numpy#22266 Add examples for tri[lu]_indices_from()
ab7add7
@richierocks richierocks mentioned this issue Nov 8, 2022
Merged
@jnclt jnclt mentioned this issue Dec 3, 2022
Closed
rossbar added a commit that referenced this issue Jan 17, 2023
@richierocks @rossbar
DOC: #22266 Add examples for tril_indices_from(), triu_indices_from() (…
b511719 
…#22562)

* DOC: #22266 Add examples for tri[lu]_indices_from()

* DOC: see also for tri[lu]_indices_from()

* DOC: Fix triu_indices_from example and minor updates.
 * incides -> indices
 * Update wording surrounding .

Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
mattip added a commit that referenced this issue Jan 26, 2023
@mattip
Merge pull request #22559 from richierocks/document_diag_indices_from
2289292 
DOC #22266 Add examples for diag_indices_from()
@MohitKumar020291 MohitKumar020291 mentioned this issue Jun 20, 2023
Closed
@MohitKumar020291
Copy link
Contributor

Opened PR. Please review it.

@MohitKumar020291 MohitKumar020291 mentioned this issue Jun 21, 2023
Closed
@MohitKumar020291
Copy link
Contributor

Opened a new PR. Please review it.

@ankur0904 ankur0904 mentioned this issue Sep 9, 2023
Closed
@bhavyaalekhya
Copy link
Contributor

bhavyaalekhya commented Sep 22, 2023 •
edited
Loading

Hi! I'd like to work on this as a part of GHC OSD'23

#24783

This was referenced May 20, 2024
Merged
Merged
@luxedo
Copy link
Contributor

luxedo commented May 20, 2024

I worked on the main branch but it's already in version 2.1.

I created examples for get_printoptions #26488 and get_include #26489. sometrue is now on ma/core.py and it's an alias for logical_or.reduce.

I feel that this issue is outdated. If you want I can bring the changes to maintenance/1.26.x and add the sometrue documentation as well.

@mattip
Copy link
Member

mattip commented May 21, 2024

I don't think a backport is required. We can close this once the last PRs are merged.

@mattip
Copy link
Member

mattip commented May 21, 2024

Closing. Thanks to all who contributed.

@mattip mattip closed this as completed May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
04 - Documentation sprintable Issue fits the time-frame and setting of a sprint
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests