Skip to content

feat: support histogram plot using maidr-ts #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025
Merged

Conversation

dakshpokar
Copy link
Collaborator

Description

This PR adds support for histogram plots in py-maidr using maidr-ts engine. Please note that adding support for histogram using maidr-ts eliminates backwards support using py-maidr with maidr-js engine.

Type of Change

  • Bug fix
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds support for histogram plots using the maidr-ts engine and removes backwards compatibility with the maidr-js engine. Key changes include:

  • Updating both Matplotlib and Seaborn examples to explicitly set the engine to "ts".
  • Renaming histogram plot keys in the core enumeration to a camelCase format.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
example/histogram/matplotlib/example_mpl_hist.py Updated engine setting to "ts" for Matplotlib example
example/histogram/seaborn/example_sns_hist.py Updated engine setting to "ts" for Seaborn example
maidr/core/enum/maidr_key.py Changed histogram key constants to camelCase format
Comments suppressed due to low confidence (1)

maidr/core/enum/maidr_key.py:38

  • [nitpick] The updated key names now use camelCase (e.g., 'xMin') which differs from the previous naming convention; ensure that the rest of the codebase and documentation reflect this change for consistency.
X_MIN = "xMin"

Copy link
Member

@jooyoungseo jooyoungseo left a comment

Choose a reason for hiding this comment

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

LGTM. Go ahead and merge once ready.

@dakshpokar dakshpokar merged commit bcc7269 into main Mar 27, 2025
9 checks passed
@dakshpokar dakshpokar deleted the feat/support-histogram branch March 27, 2025 03:12
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.

2 participants