Skip to content

Conversation

@InesaFitsner
Copy link
Contributor

@InesaFitsner InesaFitsner commented Oct 14, 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

Integrate autogenerated control screenshots into documentation and code examples by extending docs front-matter and class summaries, embedding demo images, adding usage snippets in control docstrings, and providing integration tests and example scripts to generate and verify those images.

New Features:

  • Add standalone example script for the Badge control under examples/controls

Enhancements:

  • Embed code usage snippets in AppBar, Banner, AlertDialog, Badge, and Markdown control classes
  • Enrich docs front-matter for multiple controls to reference golden screenshot paths and include image captions

Documentation:

  • Update control docs (badge, appbar, banner, alertdialog, markdown, dropdownm2) to use generated example_images and example_media paths and display embedded screenshots

Tests:

  • Add integration tests to capture and validate screenshots for Badge, Banner, AlertDialog, AppBar, and Markdown controls

Updated Markdown documentation to include a new example image and code snippet. Added an integration test and golden image for Markdown rendering to improve test coverage and documentation clarity.
Updated AlertDialog documentation to include a new example image and code snippet. Added an integration test and golden image for AlertDialog to improve test coverage and documentation clarity.
Improved AppBar documentation with new example image and code snippet. Updated image paths in appbar.md and dropdownm2.md. Added an integration test for AppBar and a corresponding golden image for documentation.
Enhanced Badge documentation with example images and media references. Added an integration test and golden image for Badge control, and included a usage example in the Badge class docstring.
Introduced a new badge example in sdk/python/examples/controls/badge/basic.py and referenced it in the documentation. Updated integration tests to use the new example and added a corresponding golden image for screenshot comparison.
Updated Banner documentation to include a new example image and code snippet. Added an integration test and golden image for Banner control to improve test coverage and documentation clarity.
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine

@FeodorFitsner FeodorFitsner merged commit d2ce854 into main Oct 14, 2025
55 checks passed
@FeodorFitsner FeodorFitsner deleted the inesa/control-docs-P3 branch October 14, 2025 21:33
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