Insert feedback or comment on a notebook

[Johannes Feist]

Hi all,

my students/collaborators now often send intermediate reports and updates as jupyter notebooks, so I can directly see their latest code and data. I would often like to insert comments in there to give feedback or for example suggest another approach (as is easily possible in, e.g., PDF or Word). Does anyone have any suggestion for a similar workflow with jupyter notebooks? Is there maybe an extension that provides something like this?

Thanks!

Johannes

--

Johannes Feist
IFIMAC & Departamento de Física Teórica de la Materia Condensada
Universidad Autónoma de Madrid
johanne...@uam.es

[Matthias Bussonnier]

Hi Johannes,

Thanks for your questions. So far no, there is no good way to annotate
a notebook in a notebook interface. But I would have look at what can
be done with JupyterLab[1], there is this video from PyData[2], and a
new one from JupyterCon should hopefully be up soon.
Once you install the Google Drive extensions you can have a chat
"attached" to a notebook, – I'm unsure if you can comment per cell,
but it's just a question of implementing it. Google Drive is only a
first stem at some point we hope to have a service you can locally
install allowing you to do this.
We've also talked about having some kind of integration with
https://web.hypothes.is/ but haven't worked on that much.

Does that answer your question ?

--
Matthias

[1]: https://github.com/jupyterlab/jupyterlab
[2]: https://channel9.msdn.com/Events/PyData/Seattle2017/BRK11

> --
> You received this message because you are subscribed to the Google Groups
> "Project Jupyter" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to jupyter+u...@googlegroups.com.
> To post to this group, send email to jup...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/jupyter/CAPERba0mz0L-pbw%3Dv%2B2buY9%3D97TzBfAfNAKa5-9BL5xTZ_Vs9A%40mail.gmail.com.
> For more options, visit https://groups.google.com/d/optout.

[Tony Hirst]

We used to use a simple extension that allowed a commenter to add their own response cells to a notebook and then colour them (we also had coloured cells to define activities https://blog.ouseful.info/2014/10/08/edtech-and-ipython-notebooks-answer-reveals/  For feedback, we tutors selected their comment cells and then used a toolbar button to toggle their colour to pink. I think the buttons still work in https://hub.docker.com/r/psychemedia/ou-tm351-jupyter-custom/ ) .

My extension broke some time ago though (changes to the notebook html structure broke the paths I was using to handle the styling) and I haven't been able to fix them. (What I did want to explore was using an extension to add metadata tags to cells and then use those as the basis for styling?)

--tony

[Tony Hirst]

PS another option may be to use nbdime - but this would require students to run that and compare their submitted notebook to one returned by a marker.

On Thursday, 7 September 2017 15:55:01 UTC+1, Johannes Feist wrote:

[Johannes Feist]

Thanks a lot Matthias and Tony!

These are some useful options, I'll try them and see how it goes. The integration with https://web.hypothes.is/ sounds like it would be really cool, although it looks like a "heavy" tool to bring in.

I wonder how hard it would be to implement a proof-of-concept jupyterlab extension that doesn't rely on an external service and shows a comment region next to each cell (with the content saved in the metadata). If I had time (and knew any javascript), I would maybe try implementing that...

Johannes

--

You received this message because you are subscribed to the Google Groups "Project Jupyter" group.
To unsubscribe from this group and stop receiving emails from it, send an email to jupyter+u...@googlegroups.com.
To post to this group, send email to jup...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/jupyter/1c56ca9d-de74-46d3-8945-806caa243278%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.