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

Small notebook fixes #2198

Merged
merged 5 commits into from Dec 19, 2017

Conversation

Projects
None yet
3 participants
@philippjfr
Member

philippjfr commented Dec 14, 2017

Minor fixes/improvements to existing notebooks.

@philippjfr philippjfr added the docs label Dec 14, 2017

@jlstevens

This comment has been minimized.

Member

jlstevens commented Dec 14, 2017

One thing I was meaning to do was to add some info about hv.help to the element notebooks. I am happy to do that in this PR once you are done with your fixes.

@philippjfr

This comment has been minimized.

Member

philippjfr commented Dec 14, 2017

I'm done for now, so go ahead.

@jlstevens

This comment has been minimized.

Member

jlstevens commented Dec 18, 2017

I'll do that now but because I will need to touch all the element notebooks I want to decide on the message now because I won't want to change it later.

  1. Should the message be at the start or the end of the element notebooks? I am leaning towards the latter.
  2. Should the message be generic so it can copy/pasted or should it mention the element name? Latter is nicer but more effort (so I guess I'll do that?).

Assuming it is something I append to the element notebooks, maybe it could be something like this, e.g for Curve:

To get additional help as well as a list of available style and plot options, use hv.help(hv.Curve).

Is that any good and do you think that would assist people?

@jbednar

This comment has been minimized.

Member

jbednar commented Dec 18, 2017

I think at the end is easier to ignore once people get it, and it isn't the first thing they will want to do even if it's new to them. I'd vote for:

For full documentation and the available style and plot options, use hv.help(hv.Curve).

It would be nice if the output of hv.help(hv.Curve) could be linked to the text hv.help(hv.Curve), but that maybe too much work for today?

@jlstevens

This comment has been minimized.

Member

jlstevens commented Dec 18, 2017

It would be nice if the output of hv.help(hv.Curve) could be linked to the text hv.help(hv.Curve), but that maybe too much work for today?

Not today, but I'll use the format you suggested, thanks!

@jlstevens

This comment has been minimized.

Member

jlstevens commented Dec 19, 2017

It was pretty tedious going but all the element notebooks are now updated with a pointer to hv.help at the end.

Happy to see this PR merged if @philippjfr agrees it is ready.

@philippjfr

This comment has been minimized.

Member

philippjfr commented Dec 19, 2017

Thanks, looks good but tedious indeed. Will merge now.

@philippjfr philippjfr merged commit 2827526 into master Dec 19, 2017

4 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls First build on master at 81.104%
Details
s3-reference-data-cache Test data is cached.
Details

philippjfr added a commit that referenced this pull request Feb 9, 2018

@philippjfr philippjfr added this to the 1.9.3 milestone Feb 11, 2018

@philippjfr philippjfr deleted the notebook_fixes branch Feb 11, 2018

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