Skip to content

Document generated widget options - #1741

Closed
Kkkakania wants to merge 1 commit into
holoviz:mainfrom
Kkkakania:codex/document-widget-options
Closed

Document generated widget options#1741
Kkkakania wants to merge 1 commit into
holoviz:mainfrom
Kkkakania:codex/document-widget-options

Conversation

@Kkkakania

Copy link
Copy Markdown

Summary

  • document the actual right_top default for generated widget placement
  • add widgets, widget_layout, and widget_type to the public converter option reference
  • add executable examples for a custom widget type, horizontal widget layout, and a multi-dimension scrubber

The new reference stays in the existing size and layout options page and does not overlap with the broader widget-guide reorganization in #1654.

Closes #1108.

Validation

  • python -m pytest hvplot/tests/testpanel.py -q (3 passed)
  • python -m pytest --nbval-lax -p no:python doc/ref/plotting_options/size_layout.ipynb -q (14 passed)
  • pre-commit run --files hvplot/converter.py doc/ref/plotting_options/size_layout.ipynb (all hooks passed)
  • jq empty doc/ref/plotting_options/size_layout.ipynb
  • git diff --check

AI disclosure: OpenAI Codex assisted with repository inspection, the documentation changes, and local validation under Kkkakania's direction.

@maximlt

maximlt commented Jul 15, 2026

Copy link
Copy Markdown
Member

We decided not to document these options in details as there is a chance they will be deprecated/modified. Enabling them returns a Panel object instead of a HoloViews object, which we want to fix, and in doing so the API may change. So we don't want users starting to leverage them.

@Kkkakania

Copy link
Copy Markdown
Author

Understood, thanks for the context. I agree that the reference should not encourage use of an API that may be deprecated or substantially changed, so I'm closing this PR.

@Kkkakania Kkkakania closed this Jul 16, 2026
@Kkkakania
Kkkakania deleted the codex/document-widget-options branch August 9, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document widget_* kwargs

2 participants