Skip to content

Conversation

@cvanelteren
Copy link
Collaborator

Summary

This PR updates the documentation in ultraplot/docs/subplots.py to clarify the functionality of the abc parameter for formatting subplot labels and its usage in the format command. The changes aim to provide a comprehensive explanation of how users can utilize the abc parameter across different contexts.

Changes

  • Revised the wording to explain that the abc parameter can:
    • Be used as a template to format subplot labels, such as "A.", which assigns alphabetic labels based on the axis number.
    • Accept a list, where the elements of the list are used as labels for the subplots.
  • Updated the documentation to highlight that the abc parameter can also be enabled via the format command by setting abc=True.

Motivation

The previous documentation mentioned "a-b-c" labels but did not clearly describe the flexibility of the abc parameter or its integration with the format command. This update ensures users understand how to leverage this feature for customized labeling in both subplot creation and formatting.

Addresses #305

@codecov
Copy link

codecov bot commented Aug 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Contributor

@Hem-W Hem-W left a comment

Choose a reason for hiding this comment

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

Thank you for your quick update. Hope these further improvements to abc documentation and examples help.

cvanelteren and others added 4 commits August 25, 2025 15:39
Co-authored-by: Hui-Min Wang <38481514+Hem-W@users.noreply.github.com>
Co-authored-by: Hui-Min Wang <38481514+Hem-W@users.noreply.github.com>
Co-authored-by: Hui-Min Wang <38481514+Hem-W@users.noreply.github.com>
Co-authored-by: Hui-Min Wang <38481514+Hem-W@users.noreply.github.com>
@cvanelteren cvanelteren merged commit 4122a6d into Ultraplot:main Aug 25, 2025
25 checks passed
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.

3 participants