Skip to content

DOC: improve QuickPlot docstring with Examples, Notes and fix variable_limits description#5482

Open
Omesh37 wants to merge 3 commits intopybamm-team:mainfrom
Omesh37:doc/improve-quickplot-docstring
Open

DOC: improve QuickPlot docstring with Examples, Notes and fix variable_limits description#5482
Omesh37 wants to merge 3 commits intopybamm-team:mainfrom
Omesh37:doc/improve-quickplot-docstring

Conversation

@Omesh37
Copy link
Copy Markdown

@Omesh37 Omesh37 commented Apr 30, 2026

Description

Improves the QuickPlot class docstring in src/pybamm/plotting/quick_plot.py.

  • Expanded output_variables description with nested list behavior
  • Fixed bullet point position for variable_limits
  • Added Notes section for variable discovery
  • Added Examples section

Also updated CHANGELOG.md under the unreleased section.

Fixes #5481

Type of change

Documentation improvement

Important checks

  • nox -s pre-commit
  • nox -s tests
  • nox -s doctests

@Omesh37 Omesh37 requested a review from a team as a code owner April 30, 2026 15:30
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.

DOC: Improve QuickPlot docstring - document nested list behavior in output_variables and fix variable_limits parameter description.

1 participant