Skip to content

Commit

Permalink
Merge pull request #4656 from voxel51/patch-python-panel-docs
Browse files Browse the repository at this point in the history
Python panel docs updates
  • Loading branch information
brimoor authored Aug 19, 2024
2 parents 87aefb1 + bd56a83 commit f5c1da4
Show file tree
Hide file tree
Showing 12 changed files with 941 additions and 111 deletions.
24 changes: 12 additions & 12 deletions docs/source/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -815,7 +815,7 @@ FiftyOne deployments.
FiftyOne operators
------------------

Tools for working with FiftyOne operators.
Tools for working with FiftyOne operators and panels.

.. code-block:: text
Expand All @@ -831,15 +831,15 @@ Tools for working with FiftyOne operators.
available commands:
{list,info}
list List operators that you've downloaded or created locally.
info Prints information about operators that you've downloaded or created
list List operators and panels that you've installed locally.
info Prints information about operators and panels that you've installed locally.
.. _cli-fiftyone-operators-list:

List operators
~~~~~~~~~~~~~~

List operators that you've downloaded or created locally.
List operators and panels that you've installed locally.

.. code-block:: text
Expand All @@ -851,8 +851,8 @@ List operators that you've downloaded or created locally.
optional arguments:
-h, --help show this help message and exit
-e, --enabled only show enabled operators
-d, --disabled only show disabled operators
-e, --enabled only show enabled operators and panels
-d, --disabled only show disabled operators and panels
-o, --operators-only only show operators
-p, --panels-only only show panels
-n, --names-only only show names
Expand All @@ -861,17 +861,17 @@ List operators that you've downloaded or created locally.

.. code-block:: shell
# List all locally available operators
# List all available operators and panels
fiftyone operators list
.. code-block:: shell
# List enabled operators
# List enabled operators and panels
fiftyone operators list --enabled
.. code-block:: shell
# List disabled operators
# List disabled operators and panels
fiftyone operators list --disabled
.. code-block:: shell
Expand All @@ -884,7 +884,7 @@ List operators that you've downloaded or created locally.
Operator info
~~~~~~~~~~~~~

Prints information about operators that you've downloaded or created locally.
Prints information about operators and panels that you've installed locally.

.. code-block:: text
Expand All @@ -895,7 +895,7 @@ Prints information about operators that you've downloaded or created locally.
.. code-block:: text
positional arguments:
URI the operator URI
URI the operator or panel URI
optional arguments:
-h, --help show this help message and exit
Expand All @@ -904,7 +904,7 @@ Prints information about operators that you've downloaded or created locally.

.. code-block:: shell
# Prints information about an operator
# Prints information about an operator or panel
fiftyone operators info <uri>
.. _cli-fiftyone-delegated:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f5c1da4

Please sign in to comment.