Skip to content
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

a few examples in docs #66

Merged
merged 1 commit into from
Jan 16, 2020
Merged

a few examples in docs #66

merged 1 commit into from
Jan 16, 2020

Conversation

choldgraf
Copy link
Contributor

@choldgraf choldgraf commented Jan 12, 2020

Hello 👋 per some of my experiences in #65 , I thought it would be helpful to add two examples to the documentation. This PR does the following:

  1. Adds code to demonstrate a custom encoder with a simple Altair example
  2. Adds code to demonstrate using the display encoder with Matplotlib figures
  3. Adds a link to the docs in the README because I missed it the first time :-)

Let me know if this is helpful, or if folks would like to see changes!

closes #65

@codecov
Copy link

codecov bot commented Jan 12, 2020

Codecov Report

Merging #66 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master     #66   +/-   ##
======================================
  Coverage    96.5%   96.5%           
======================================
  Files          10      10           
  Lines         486     486           
======================================
  Hits          469     469           
  Misses         17      17

@MSeal
Copy link
Member

MSeal commented Jan 15, 2020

Thanks for posting the PR -- I'll let you read the comments I left on the issue and see how you'd want to update the doc additions.

@choldgraf
Copy link
Contributor Author

choldgraf commented Jan 15, 2020

Looking at your comments, I think that these doc additions could be useful. This PR gives an example that shows off the pattern that you suggested (using 'display' to store only the display information), as well as another example to show how to create a custom encoder that stores information about the plot itself. I think both examples would have helped me come to this conclusion more quickly. What do you think?

Copy link
Member

@MSeal MSeal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds like a fair assessment -- we can adjust docs if later changes make it more convenient. Thanks!

@MSeal MSeal merged commit 604c54f into nteract:master Jan 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Possible to use with figures / plots?
2 participants