Skip to content

Centralise documentation for the output widget #1935

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

Closed
pbugnion opened this issue Jan 26, 2018 · 4 comments
Closed

Centralise documentation for the output widget #1935

pbugnion opened this issue Jan 26, 2018 · 4 comments
Labels
docs good first issue resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Milestone

Comments

@pbugnion
Copy link
Member

Currently, documentation for the output widget is scattered across:

With PR #1934 , we need to extend the docs for the output widget to expose its use as a decorator.

Given the output widget's power, we think it makes sense to bring docs on the output widget to the top level. I think it would be useful to structure the notebook as:

  • introduction (what's currently in the widget list)
  • displaying rich output (e.g., with an example from matplotlib?)
  • async widgets
  • using the @capture decorator, including as a way to debug widget callbacks.

Happy to tackle this today / this weekend, unless someone else is particularly keen to.


Jason deserves the credit for the idea behind this issue.

@jasongrout
Copy link
Member

Definitely +1. I started an output widget notebook a while ago, but I'm not sure I pushed it anywhere.

@jasongrout jasongrout added this to the Patch release milestone Jan 29, 2018
@jasongrout
Copy link
Member

Here is the output notebook I started working on a while ago. Feel free to use it as a start, or feel free to discard it and do what you think is best: https://gist.github.com/anonymous/eb176705a103517179b4f57b6201df1d

@jasongrout
Copy link
Member

#1936 also has some interesting material that could be incorporated in an output notebook.

@jasongrout jasongrout modified the milestones: Patch release, 7.2 Mar 29, 2018
@jasongrout
Copy link
Member

Fixed by #2020. Thanks again!

@github-actions github-actions bot added the resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion. label Feb 8, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs good first issue resolved-locked Closed issues are locked after 30 days inactivity. Please open a new issue for related discussion.
Projects
None yet
Development

No branches or pull requests

2 participants