jupyter-widgets / ipydatagrid

Fast Datagrid widget for the Jupyter Notebook and JupyterLab
BSD 3-Clause "New" or "Revised" License
580 stars 51 forks source link

Add API docs (at least for `DataGrid`) #552

Open taldcroft opened 1 month ago

taldcroft commented 1 month ago

As far as I can see there is no API documentation for ipydatagrid, and in particular no easy web-accessible way to discover the available options for DataGrid.

Astropy is incorporating ipydatagrid as the default way of providing a rich display of a table (https://github.com/astropy/astropy/pull/17165), with a pass-through kwargs to allow customization of the DataGrid object. It would be very nice to help our users with a link to documentation on the available keyword arguments.

martinRenou commented 1 month ago

Agreed!