@@ -86,15 +86,17 @@ up-to-date official documentation that can be easily updated.
86
86
Status and ideas of each type of doc content
87
87
--------------------------------------------
88
88
89
- **Reference guide **
89
+ Reference guide
90
+ ^^^^^^^^^^^^^^^
90
91
91
92
NumPy has a quite complete reference guide. All functions are documented, most
92
93
have examples, and most are cross-linked well with *See Also * sections. Further
93
94
improving the reference guide is incremental work that can be done (and is being
94
95
done) by many people. There are, however, many explanations in the reference
95
96
guide. These can be moved to a more dedicated Explanations section on the docs.
96
97
97
- **How-to guides **
98
+ How-to guides
99
+ ^^^^^^^^^^^^^
98
100
99
101
NumPy does not have many how-to's. The subclassing and array ducktyping section
100
102
may be an example of a how-to. Others that could be added are:
@@ -106,15 +108,16 @@ may be an example of a how-to. Others that could be added are:
106
108
- Performance (memory layout, profiling, use with Numba, Cython, or Pythran)
107
109
- Writing generic code that works with NumPy, Dask, CuPy, pydata/sparse, etc.
108
110
109
- **Explanations **
111
+ Explanations
112
+ ^^^^^^^^^^^^
110
113
111
114
There is a reasonable amount of content on fundamental NumPy concepts such as
112
115
indexing, vectorization, broadcasting, (g)ufuncs, and dtypes. This could be
113
116
organized better and clarified to ensure it's really about explaining the concepts
114
117
and not mixed with tutorial or how-to like content.
115
118
116
119
There are few explanations about anything other than those fundamental NumPy
117
- concepts.
120
+ concepts.
118
121
119
122
Some examples of concepts that could be expanded:
120
123
@@ -125,7 +128,8 @@ Some examples of concepts that could be expanded:
125
128
In addition, there are many explanations in the Reference Guide, which should be
126
129
moved to this new dedicated Explanations section.
127
130
128
- **Tutorials **
131
+ Tutorials
132
+ ^^^^^^^^^
129
133
130
134
There's a lot of scope for writing better tutorials. We have a new *NumPy for
131
135
absolute beginners tutorial * [3 ]_ (GSoD project of Anne Bonner). In addition we
@@ -154,19 +158,15 @@ propose a *How to write a tutorial* document, which would help users contribute
154
158
new high-quality content to the documentation.
155
159
156
160
Data sets
157
- ---------
161
+ ~~~~~~~~~
158
162
159
163
Using interesting data in the NumPy docs requires giving all users access to
160
164
that data, either inside NumPy or in a separate package. The former is not the
161
165
best idea, since it's hard to do without increasing the size of NumPy
162
- significantly. Even for SciPy there has so far been no consensus on this (see
163
- `scipy PR 8707 <https://github.com/scipy/scipy/pull/8707 >`_ on adding a new
164
- ``scipy.datasets `` subpackage).
165
-
166
- So we'll aim for a new (pure Python) package, named ``numpy-datasets `` or
167
- ``scipy-datasets `` or something similar. That package can take some lessons from
168
- how, e.g., scikit-learn ships data sets. Small data sets can be included in the
169
- repo, large data sets can be accessed via a downloader class or function.
166
+ significantly.
167
+
168
+ Whenever possible, documentation pages should use examples from the
169
+ :mod: `scipy.datasets ` package.
170
170
171
171
Related work
172
172
============
0 commit comments