Skip to content

Canvas, Charts controls docstrings #5343

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 39 commits into from
May 29, 2025

Conversation

InesaFitsner
Copy link
Contributor

@InesaFitsner InesaFitsner commented May 29, 2025

Description

Test Code

# Test code for the review of this PR

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • I signed the CLA.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing tests pass locally with my changes
  • I have made corresponding changes to the documentation (if applicable)

Screenshots

Additional details

Summary by Sourcery

Add comprehensive docstrings and default values to canvas, chart, and related controls in the Python SDK to improve user-facing documentation and clarify property usage.

Enhancements:

  • Standardize type hints by replacing typing.List with native list and updating Tuple to tuple where applicable.
  • Introduce default values for various boolean properties (e.g., show_tooltip) and clarify default behaviors in docstrings.
  • Add missing default value documentation across multiple controls and clarify behavior of tooltip, grid lines, axis labels, and border radius properties.

Documentation:

  • Add descriptive docstrings to all chart controls (LineChart, BarChart, PieChart, ScatterChart and related data types) explaining properties, events, and defaults.
  • Add descriptive docstrings to all canvas shapes (Path, Text, Arc, Rect, Line, Oval, etc.) explaining parameters and usage.
  • Add descriptive docstrings to alignment, border, animation, and other core types to clarify factory methods and properties.

@FeodorFitsner FeodorFitsner merged commit b0721df into v1 May 29, 2025
1 of 3 checks passed
@FeodorFitsner FeodorFitsner deleted the inesa/v1-canvas-charts-controls-docstrings branch May 29, 2025 20:43
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