Add dim_to_str method to labellers#200
Open
chrberrig wants to merge 1 commit into
Open
Conversation
Documentation build overview
26 files changed ·
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a dim_to_str method to the labeller API.
BaseLabeller.dim_to_str returns the provided dimension name unchanged, while MapLabeller.dim_to_str applies dim_map before delegating to the base implementation.
This provides a public labeller method for formatting dimension names in contexts where only the dimension name is available, avoiding direct access to MapLabeller.dim_map.
Changes:
Add BaseLabeller.dim_to_str
Add MapLabeller.dim_to_str
Update type stubs
Add tests covering:
default behavior in BaseLabeller
mapped dimensions in MapLabeller
unmapped dimensions in MapLabeller
None handling
Motivation:
While working on label handling in arviz-plots, I found that dimension-name-only formatting currently requires direct access to MapLabeller.dim_map.
This change exposes a public API that downstream projects can use instead.
For context, see #507 of arviz_plots