search

educational-technology-collective / jupyterlab-pioneer

A JupyterLab extension for generating and exporting JupyterLab event telemetry data.
https://jupyterlab-pioneer.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
11 stars 2 forks source link

Class docs @mengyanw #26

Closed cab938 closed 10 months ago

cab938 commented 10 months ago

https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/6ae3a58fee2321c633d339fafe0435529709ff0e/src/producer.ts#L16-L52

cab938 commented 10 months ago

Ideally we have docs that describe the context of the event as well as any input parameters that the caller might need to define. Imagine I want to hand this off to an undergraduate student, say someone like Barath, and want them to implement a new event or producer to the system, or tell me from log data what actually happened in the UI.

mengyanw commented 10 months ago

@cab938 Event library table added: https://jupyterlab-pioneer.readthedocs.io/en/latest/event_library.html How to implement a custom event extension: https://jupyterlab-pioneer.readthedocs.io/en/latest/custom_event.html