Skip to content

DOC: Merge two indexing documentation pages #14038

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.

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

Closed
sameshl opened this issue Jul 17, 2019 · 5 comments · Fixed by #19407
Closed

DOC: Merge two indexing documentation pages #14038

sameshl opened this issue Jul 17, 2019 · 5 comments · Fixed by #19407

Comments

@sameshl
Copy link
Contributor

sameshl commented Jul 17, 2019

xref:#12195
Currently we have:

https://docs.scipy.org/doc/numpy-1.15.0/user/basics.indexing.html
https://docs.scipy.org/doc/numpy-1.13.0/reference/arrays.indexing.html

I added a link between each other on pr #14025 but the info still remains a bit haywire and lot of the info could be merged.
Making it a issue so I could get any suggestions on how they could be improved. I will start working on this

EDIT: latest versions:

@mattip
Copy link
Member

mattip commented Sep 12, 2019

@sameshl did you get anywhere with this?

@sameshl
Copy link
Contributor Author

sameshl commented Sep 14, 2019

@mattip Not much actually 😅. But I can finish it by the end of this weekend. It would greatly help if I could get a rough TOC of how the indexing pages could be.

@mattip
Copy link
Member

mattip commented Sep 14, 2019

I think the user page should be greatly reduced, and refer to the reference page for more information. Perhaps the basic idea below should be echoed on the user page, with a link to the reference page. I would remove the "Single element indexing", "Other indexing options", "Index arrays", "Indexing Multi-dimensional arrays", "Boolean or “mask” index arrays", and "Combining index arrays with slices", but make sure the content exists on the reference page. The other sections are a bit different, and contain information that could stay there.

I like the layout of the reference page. The information you remove from the user page about mixing indexing types should be merged in under Advanced Indexing".

ndarrays can be indexed using the standard Python x[obj] syntax, where x is the array and obj the selection. There are three kinds of indexing available: field access, basic slicing, advanced indexing. Which one occurs depends on obj.

Of course once we see how it looks maybe we will decide to rearrange it differently.

@PraveshMoelchand
Copy link

Hi @sameshl, have you made any progress with this? I'd like to help out with this issue!

@sameshl
Copy link
Contributor Author

sameshl commented Mar 15, 2020

@PraveshMoelchand I have not done much on this issue. You can take this up 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy