Skip to content

Reorganize Widgets User guide#1654

Open
Azaya89 wants to merge 9 commits intomainfrom
widgets_guide
Open

Reorganize Widgets User guide#1654
Azaya89 wants to merge 9 commits intomainfrom
widgets_guide

Conversation

@Azaya89
Copy link
Copy Markdown
Collaborator

@Azaya89 Azaya89 commented Aug 5, 2025

fixes #1641

  • Create how-to section and notebook for widgets exploration
  • Move panel widgets part to reference section
  • Create Explanation section and notebook for groupby vs by vs color

@Azaya89 Azaya89 requested a review from Copilot August 5, 2025 15:12

This comment was marked as resolved.

@Azaya89 Azaya89 self-assigned this Aug 8, 2025
@Azaya89 Azaya89 added the NF SDG 2025 NumFocus Software Development Grant 2025 label Aug 8, 2025
Comment thread doc/ref/api_compatibility/panel_widgets.ipynb Outdated
Comment thread doc/how_to/explore_with_widgets.ipynb Outdated
Comment thread doc/how_to/explore_with_widgets.ipynb Outdated
Comment thread doc/how_to/explore_with_widgets.ipynb Outdated
Comment thread doc/how_to/explore_with_widgets.ipynb Outdated
Comment thread doc/explanation/grouping_options.ipynb
Comment thread doc/explanation/grouping_options.ipynb Outdated
Comment thread doc/explanation/grouping_options.ipynb
Comment thread doc/explanation/grouping_options.ipynb Outdated
"id": "817592aa",
"metadata": {},
"source": [
"## Overview of the Three Approaches\n",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this comment after going through the whole notebook. I like it but think it can be re-organized a little to be even better. How I see it is that there are three main use cases:

  • Drilling down a dataset with widgets -> groupby
  • Facetting a dataset -> by + subplots
  • Color a dataset

The first two are pretty straightforward to explain. The last one is where things are a bit more subtle are users can use wither by or c/color but there are differences:

  • by:
    • Creates containers (can be indexed and stuff)
    • Accept a list of dimensions
    • Generates an overlay -> If many overlays (many values in a dimension) then performance can be affected
    • Works only for categorical data (i.e. no nice colorbar for numerical data)
  • color:
    • Single Element returned
    • Does not accept a list of dimensions
    • Can also be used for getting a nice colorbar

And I would document color before by as I think most users should probably use color?

Copy link
Copy Markdown
Collaborator Author

@Azaya89 Azaya89 Aug 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arranging them this way is a bit more 'poetic' as it kinda rolls off the tongue better: groupby -> by -> color. Putting color in-between both kinda breaks the flow IMO.

@Azaya89 Azaya89 requested a review from maximlt August 28, 2025 22:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NF SDG 2025 NumFocus Software Development Grant 2025

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Break down the Widgets user guide

3 participants