diff options
author | Ben Nathanson <github@bigriver.xyz> | 2020-09-22 08:49:44 -0400 |
---|---|---|
committer | Ben Nathanson <github@bigriver.xyz> | 2020-09-22 08:49:44 -0400 |
commit | 0a93d77580656c7451d7f3dc31eaa9c1fcb76881 (patch) | |
tree | eaa505f48439c501547338f5b9ea61c68496605b /doc/source/user | |
parent | 7f3b65c77a99eace07b1e44c5c4fdfb5829fdd90 (diff) | |
download | numpy-0a93d77580656c7451d7f3dc31eaa9c1fcb76881.tar.gz |
DOC: Revise #17352 with @mattip suggestions
Diffstat (limited to 'doc/source/user')
-rw-r--r-- | doc/source/user/how-to-how-to.rst | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/doc/source/user/how-to-how-to.rst b/doc/source/user/how-to-how-to.rst index 48feae6db..de8afc28a 100644 --- a/doc/source/user/how-to-how-to.rst +++ b/doc/source/user/how-to-how-to.rst @@ -14,39 +14,39 @@ How-tos get straight to the point -- they A stranger has asked for directions...
******************************************************************************
-**"I need to fill my tank."**
+**"I need to refuel my car."**
******************************************************************************
Give a brief but explicit answer
******************************************************************************
- - `"Three miles, take a right at Hayseed Road, it's on your left."`
+ - `"Three kilometers/miles, take a right at Hayseed Road, it's on your left."`
Add helpful details for newcomers ("Hayseed Road", even though it's the only
-turnoff at three miles). But not irrelevant ones:
+turnoff at three km/mi). But not irrelevant ones:
- Don't also give directions from Route 7.
- - Don't explain why the town has only one gas station.
+ - Don't explain why the town has only one filling station.
If there's related background (tutorial, explanation, reference, alternative
approach), bring it to the user's attention with a link ("Directions from Route 7,"
-"Why so few gas stations?").
+"Why so few filling stations?").
******************************************************************************
Delegate
******************************************************************************
- - `"Three miles, take a right at Hayseed Road, follow the signs."`
+ - `"Three km/mi, take a right at Hayseed Road, follow the signs."`
If the information is already documented and succinct enough for a how-to,
-just link to it, possibly after an introduction ("Three miles, take a right").
+just link to it, possibly after an introduction ("Three km/mi, take a right").
******************************************************************************
If the question is broad, narrow and redirect it
******************************************************************************
- **"I want to see the sights"**
+ **"I want to see the sights."**
The `See the sights` how-to should link to a set of narrower how-tos:
@@ -90,7 +90,10 @@ Aren't how-tos and tutorials the same thing? ******************************************************************************
People use the terms "how-to" and "tutorial" interchangeably, but we draw a
-distinction, following `Daniele Procida <https://documentation.divio.com/>`_.
+distinction, following Daniele Procida's `taxonomy of documentation`_.
+
+ .. _`taxonomy of documentation`: https://documentation.divio.com/
+
Documentation needs to meet users where they are. `How-tos` offer get-it-done
information; the user wants steps to copy and doesn't necessarily want to
understand NumPy. `Tutorials` are warm-fuzzy information; the user wants a
@@ -102,8 +105,9 @@ deep dives intended to give understanding rather than immediate assistance, and `References`, which give complete, autoritative data on some concrete
part of NumPy (like its API) but aren't obligated to paint a broader picture.
-For more on tutorials, see
-`the tutorial how-to <https://github.com/numpy/numpy-tutorials/blob/master/tutorial_style.ipynb>`.
+For more on tutorials, see the `tutorial how-to`_.
+
+.. _`tutorial how-to`: https://github.com/numpy/numpy-tutorials/blob/master/tutorial_style.ipynb
******************************************************************************
|