Closed voxel51-bot closed 1 month ago
The recent updates to the FiftyOne documentation and codebase enhance clarity and functionality surrounding operators and panels. Key changes include consistent terminology, expanded command descriptions, and improved code examples. These modifications ensure users can effectively utilize both operators and panels within the CLI and plugin development, fostering a better understanding of the available tools and their interactions.
Files | Change Summary |
---|---|
docs/source/cli/index.rst |
Updated descriptions to include "panels" alongside "operators," enhancing clarity on CLI functionalities. |
docs/source/plugins/developing_plugins.rst |
Standardized terminology and expanded explanations, added code examples, improved formatting, and clarified state management details for plugins. |
docs/source/plugins/using_plugins.rst |
Included "panels" in command descriptions, added new --panels-only option, and modified output tables to improve usability in plugin interactions. |
fiftyone/core/cli.py |
Enhanced docstrings to reflect "operators and panels," improving understanding of command functionalities. |
fiftyone/operators/types.py |
Simplified arrow_nav function by removing on_forward and on_backward parameters, streamlining the interface for ArrowNavView . |
fiftyone/operators/panel.py |
Added "unlisted" key to the JSON output in the to_json method, enhancing the representation of the panel object state. |
app/packages/app/src/components/AnalyticsConsent.tsx |
Updated import statements for the button component, improving code organization and clarity. |
sequenceDiagram
participant User
participant CLI
participant Operators
participant Panels
User->>CLI: List available operators and panels
CLI->>Operators: Fetch list of operators
CLI->>Panels: Fetch list of panels
Operators-->>CLI: Return operator list
Panels-->>CLI: Return panel list
CLI-->>User: Display operators and panels
🐇 In the meadow, I hop and play,
With panels and operators, bright as day.
Documentation's clear, updates abound,
In this joyful world, new treasures are found!
So let's celebrate, with a leap and a cheer,
For clarity blooms, and the path is now clear! 🌼
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Merge
release/v0.25.0
todevelop
Summary by CodeRabbit
Documentation Updates
--panels-only
, in the usage documentation for improved user interactions.New Features
to_json
method now includes an"unlisted"
attribute, providing a more detailed representation of object states.