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.

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

DOC: Rename basics to fundamentals + added description #17889

Merged
merged 2 commits into from
Dec 13, 2020

Conversation

cooperrc
Copy link
Member

@cooperrc cooperrc commented Dec 1, 2020

Rename "NumPy basics" to "NumPy Fundamentals" and reorganize content

The NumPy Basics section consists of the following content:

  • Data types
  • Array creation
  • I/O with NumPy
  • Indexing
  • Broadcasting
  • Byte-swapping
  • Structured arrays
  • Writing custom array containers
  • Subclassing ndarray

These articles have very useful information for users, but they do not cover the basics. The basics are covered in Absolute Basics for beginners.

This PR adds a description to the section as explanation material and relabels the section as "NumPy Fundamentals". This documentation space can be used to clarify parts of NumPy and describe design decisions in NumPy. Most of this content is already there, but it will help to capture it in its own section and label it.

This PR reorganizes the NumPy Basics Fundamentals to the following order:

  • Array creation
  • Indexing
  • I/O with NumPy
  • Data types
  • Broadcasting
  • Byte-swapping
  • Structured arrays
  • Writing custom array containers
  • Subclassing ndarray

@charris charris changed the title renamed basics to fundamentals + added description DOC: Rename basics to fundamentals + added description Dec 4, 2020
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, the "basics" for not-at-all-basic-things had bothered me for a while.

@rgommers rgommers merged commit 8e956b4 into numpy:master Dec 13, 2020
@rgommers
Copy link
Member

Merged, thanks @cooperrc

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

Successfully merging this pull request may close these issues.

None yet

4 participants