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

Explaining the metadata exporters #27

Closed cab938 closed 10 months ago

cab938 commented 10 months ago

https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/6ae3a58fee2321c633d339fafe0435529709ff0e/src/index.ts#L80-L82

cab938 commented 10 months ago

It would be good to have some docs here to explain a bit what is happening. I'm NOT a TS person, but I'm a little unclear myself what it means if both config.exporters is true and getMetadata('exporters') returns something. I'm going to open another task I think for an architecture walkthrough doc

mengyanw commented 10 months ago

if both notebookPanel.content.model?.getMetadata('exporters') and config.exporters returns something, the exporter configuration from the metadata will override the configuration from the configuration file

mengyanw commented 10 months ago

I will add some docs to the code :)