Docs and minor code fixes #1765
Conversation
| @@ -97,11 +99,11 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "Exploring a parameter space using widgets is one of the most flexible approaches but as we noted above it also makes it difficult to compare between different parameter values. HoloViews therefore supplies several container objects, which behave similarly to a ``HoloMap`` but have a visual representation:\n", | |||
| "Exploring a parameter space using widgets is one of the most flexible approaches but as we noted above it also makes it difficult to compare between different parameter values. HoloViews therefore supplies several container objects, which behave similarly to a ``HoloMap`` but have a different visual representation:\n", | |||
There was a problem hiding this comment.
I think the idea here was not that the visual representation is different, but that there was one at all. HoloMaps simply punt on the idea of representing the additional dimensions visually, instead giving a widget so that the user is queried about which value they want to see. Other containers actually show values along that dimension simultaneously. Maybe you can see how to re-word it so that it would be both correct and clear?
There was a problem hiding this comment.
That makes much more sense! How about
'a visual representation showing the effect of all parameter values simultaneously'
| "labels_anchors": false, | ||
| "latex_user_defs": false, | ||
| "report_style_numbering": false, | ||
| "user_envs_cfg": false | ||
| } |
There was a problem hiding this comment.
I see that it's possible for Jupyter to fill notebooks with even more junk than they usually do! You might consider running the stripping command listed in #1617 (comment) , or else this can be merged and we can run that separately.
There was a problem hiding this comment.
Actually, looking through it, it would be very helpful if you could run such a stripping function on this PR, so that the real changes can be seen more clearly; most of the changes look like Jupyter's auto-generated fluff.
|
Looks good apart from minor comments above; thanks! |
| @@ -463,7 +463,7 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "Once data is in columnar form, it is simple to apply a variety of operations. For instance, Dataset can be sorted by their dimensions using the ``.sort()`` method. By default, this method will sort by the key dimensions, but any other dimension(s) can be supplied to specify sorting along any other dimensions:" | |||
| "Once data is in columnar form, it is simple to apply a variety of operations. For instance, Dataset can be sorted by their dimensions using the ``.sort()`` method. By default, this method will sort by the key dimensions, but any other dimension(s) can be sorted by providing an them as an argument list to the sort method:" | |||
| @@ -487,7 +487,7 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "Data is often grouped in various ways, and the Dataset interface provides various means to easily compare between groups and apply statistical aggregates. We'll start by generating some synthetic data with two groups along the x-axis and 4 groups along the y axis." | |||
| "Data is often grouped in various ways, and the Dataset interface provides various means to easily compare between groups and apply statistical aggregates. We'll start by generating some synthetic data with two groups along the x-axis and 4 groups along the y-axis." | |||
There was a problem hiding this comment.
"y-axis" would be an adjective, as in "y-axis label". It's correct with no -, because it's used as a noun here.
There was a problem hiding this comment.
so should it be 'along the x axis and 4 groups along the y axis.'
(no hyphen on either)
There was a problem hiding this comment.
Right. I try to train people about how to use hyphens, but no one cares about it but me. :-)
There was a problem hiding this comment.
Actually your comment had me intrigued: thanks for the link!
Re code changes, they were a better set of tick marks, a larger marker size,
and in one instance, better alignment (one of my pet peeves, I want to
see my indices at a glance), e.g.,
b = a[0][i-1] * a[1][i-1] +
a[0][i ] * a[1][i ]
| @@ -23,18 +23,18 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "HoloViews objects provide a convenient way of wrapping your data along with some metadata for exploration and visualization. For the simplest visualizations, you can simply declare a small collection of element which can then be composed or placed in an appropriate container. As soon as the task becomes more complex, it is natural to write a function of a class to output HoloViews objects.\n", | |||
| "HoloViews objects provide a convenient way of wrapping your data along with some metadata for exploration and visualization. For the simplest visualizations, you can simply declare a small collection of elements which can then be composed or placed in an appropriate container. As soon as the task becomes more complex, it is natural to functions that output HoloViews objects.\n", | |||
There was a problem hiding this comment.
natural to write functions that
|
Looks great! I haven't checked what the effects of the minor changes made to the code were, but the docs look ready to merge after the above tiny fixes. Thanks! |
|
@jbednar If you agree that all your comments have been addressed, I'm happy to merge! |
|
Hold off a little more: I am currently on 14_LargeData |
|
Sure. Just shout when you think it is ready! |
|
I won't add anything further for a few days. Just do what is most convenient for you... |
|
In that case I think we should merge if @jbednar signs off on the latest changes. |
|
Looks great, thanks! |
I made the changes suggested in #1696 that I was comfortable with.
I left out changes that would modify the structure of the documents.