@@ -86,15 +86,17 @@ up-to-date official documentation that can be easily updated.
8686Status and ideas of each type of doc content
8787-------------------------------------------- 
8888
89- **Reference guide **
89+ Reference guide
90+ ^^^^^^^^^^^^^^^ 
9091
9192NumPy has a quite complete reference guide. All functions are documented, most
9293have examples, and most are cross-linked well with *See Also * sections. Further
9394improving the reference guide is incremental work that can be done (and is being
9495done) by many people. There are, however, many explanations in the reference
9596guide. These can be moved to a more dedicated Explanations section on the docs.
9697
97- **How-to guides **
98+ How-to guides
99+ ^^^^^^^^^^^^^ 
98100
99101NumPy does not have many how-to's. The subclassing and array ducktyping section
100102may 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:
106108- Performance (memory layout, profiling, use with Numba, Cython, or Pythran)
107109- Writing generic code that works with NumPy, Dask, CuPy, pydata/sparse, etc.
108110
109- **Explanations **
111+ Explanations
112+ ^^^^^^^^^^^^ 
110113
111114There is a reasonable amount of content on fundamental NumPy concepts such as
112115indexing, vectorization, broadcasting, (g)ufuncs, and dtypes. This could be
113116organized better and clarified to ensure it's really about explaining the concepts
114117and not mixed with tutorial or how-to like content.
115118
116119There are few explanations about anything other than those fundamental NumPy
117- concepts.  
120+ concepts.
118121
119122Some examples of concepts that could be expanded:
120123
@@ -125,7 +128,8 @@ Some examples of concepts that could be expanded:
125128In addition, there are many explanations in the Reference Guide, which should be
126129moved to this new dedicated Explanations section.
127130
128- **Tutorials **
131+ Tutorials
132+ ^^^^^^^^^ 
129133
130134There's a lot of scope for writing better tutorials. We have a new *NumPy for 
131135absolute 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
154158new high-quality content to the documentation.
155159
156160Data sets
157- --------- 
161+ ~~~~~~~~~ 
158162
159163Using interesting data in the NumPy docs requires giving all users access to
160164that data, either inside NumPy or in a separate package. The former is not the
161165best 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.
170170
171171Related work
172172============ 
0 commit comments