-
Notifications
You must be signed in to change notification settings - Fork 579
Update cross-references in docstrings #5647
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry @ndonkoHenri, your pull request is larger than the review limit of 150000 diff characters
There was a problem hiding this 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 updates cross-references in docstrings across the Python SDK to use a shortened format. The changes replace full module paths like [flet.Control]
with shortened versions like [flet.]
and introduce [(c).]
references for current class properties.
Key changes include:
- Updating dependency versions in pyproject.toml to newer versions
- Converting docstring cross-references from full paths to shortened format
- Using
[(c).]
for references to current class members - Reorganizing some
__all__
imports for better alphabetical ordering
Reviewed Changes
Copilot reviewed 121 out of 122 changed files in this pull request and generated 5 comments.
File | Description |
---|---|
sdk/python/pyproject.toml | Update dependency versions for documentation tools |
sdk/python/packages/flet/src/flet/**/*.py | Convert docstring cross-references to shortened format throughout the codebase |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
sdk/python/packages/flet/src/flet/controls/material/datatable.py
Outdated
Show resolved
Hide resolved
sdk/python/packages/flet/src/flet/controls/material/container.py
Outdated
Show resolved
Hide resolved
sdk/python/packages/flet/src/flet/controls/cupertino/cupertino_action_sheet.py
Show resolved
Hide resolved
Deploying flet-docs with
|
Latest commit: |
c2dcf2d
|
Status: | ✅ Deploy successful! |
Preview URL: | https://774336ec.flet-docs.pages.dev |
Branch Preview URL: | https://v1-cross-refs.flet-docs.pages.dev |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New security issues found
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New security issues found
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry @ndonkoHenri, your pull request is larger than the review limit of 150000 diff characters
No description provided.