Open
Conversation
Deploying flet-examples with
|
| Latest commit: |
2383d19
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b62171a1.flet-examples.pages.dev |
| Branch Preview URL: | https://improve-docs.flet-examples.pages.dev |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Sorry @ndonkoHenri, your pull request is larger than the review limit of 150000 diff characters
Deploying flet-docs with
|
| Latest commit: |
2383d19
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://af2cda13.flet-docs.pages.dev |
| Branch Preview URL: | https://improve-docs.flet-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR significantly improves docstring coverage across the Flet Python SDK codebase, targeting comprehensive documentation for better developer experience. The changes include adding detailed docstrings to utility functions, controls, authentication modules, CLI tools, and extension packages. Additionally, it updates documentation URLs from the legacy flet.dev/docs to the new docs.flet.dev domain and modernizes the documentation infrastructure.
Changes:
- Added comprehensive docstrings to 100+ Python modules covering utilities, controls, components, hooks, authentication, and CLI tools
- Updated documentation infrastructure: removed
griffe-modernized-annotationsdependency, centralized.docstr.yamlconfiguration, and enhanced docstring coverage badge generation for all packages - Migrated documentation URLs from
flet.dev/docstodocs.flet.devacross docstrings and examples
Reviewed changes
Copilot reviewed 274 out of 295 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/python/pyproject.toml | Removed griffe-modernized-annotations dependency from docs group |
| sdk/python/packages/flet/mkdocs.yml | Updated mkdocs configuration to enable modernize_annotations directly and exclude files from documentation |
| sdk/python/.docstr.yaml | Added centralized docstring coverage configuration for all Python packages |
| sdk/python/Taskfile.yml | Enhanced docs-coverage task to generate badges for all SDK packages |
| sdk/python/packages/flet/src/flet/utils/*.py | Added docstrings to utility modules (typing_utils, strings, once, object_model, network, locks, etc.) |
| sdk/python/packages/flet/src/flet/controls/*.py | Added docstrings to control classes and dataclasses (types, template_route, ref, query_string, keys, etc.) |
| sdk/python/packages/flet/src/flet/controls/material/*.py | Added docstrings to Material controls (tooltip, time_picker, tabs, snack_bar, navigation components, etc.) |
| sdk/python/packages/flet/src/flet/controls/cupertino/*.py | Added docstrings to Cupertino controls (date_picker, timer_picker, textfield, switch, button, colors) |
| sdk/python/packages/flet/src/flet/controls/core/*.py | Added docstrings to core controls (view, text, stack, canvas, drag_target, dismissible, etc.) |
| sdk/python/packages/flet/src/flet/components/*.py | Added docstrings to component system (hooks, memo, public_utils) |
| sdk/python/packages/flet/src/flet/auth/*.py | Added docstrings to authentication modules (user, oauth providers, authorization) |
| sdk/python/packages/flet-cli/src/flet_cli/*.py | Added docstrings to CLI commands and utilities |
| sdk/python/packages/flet-web/src/flet_web/*.py | Added docstrings to web-specific modules |
| sdk/python/packages/flet-*/README.md | Added docstring coverage badges to extension package READMEs |
| sdk/python/packages/flet/docs/**/*.md | Updated documentation URLs and fixed typos |
| packages/flet/lib/src/utils/*.dart | Consolidated MaterialState/WidgetState utilities and refactored enum parsing |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
… flet-color-pickers to extensions dep-group
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.
No description provided.