Skip to content

Commit

Permalink
docs(cli): update module docstring for cli
Browse files Browse the repository at this point in the history
modify "cli.py", "custom.py", "tbrn.py", "utility.py" and "__init__.py"
  • Loading branch information
marshallmallows committed Nov 22, 2021
1 parent de4aa20 commit 20757e3
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 38 deletions.
2 changes: 1 addition & 1 deletion tensorbay/cli/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
# Copyright 2021 Graviti. Licensed under MIT License.
#

"""Graviti TensorBay CLI."""
"""TensorBay CLI."""
28 changes: 1 addition & 27 deletions tensorbay/cli/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,7 @@
#
# pylint: disable=import-outside-toplevel

"""Command-line interface.
Use ``gas <command>`` in terminal to operate on datasets.
Use ``gas auth`` to authenticate the accessKey of gas.
Use ``gas branch`` to list, create or delete branches.
Use ``gas commit`` to commit drafts.
Use ``gas config`` to configure the options when using gas CLI.
Use ``gas cp`` to copy local data to a remote path.
Use ``gas dataset`` to list, create or delete datasets.
Use ``gas draft`` to list or create drafts.
Use ``gas log`` to show commit logs.
Use ``gas ls`` to list data under the path.
Use ``gas rm`` to remove the remote data.
Use ``gas tag`` to list, create or delete tags.
"""
"""Definitions of TensorBay Command-line Interface commands."""

from functools import partial
from typing import Iterable, Optional, Tuple
Expand Down
2 changes: 1 addition & 1 deletion tensorbay/cli/custom.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# pylint: disable=import-outside-toplevel

"""Subclass declaration and definition of click class."""
"""Subclasses declarations and definitions of click classes."""

from types import MethodType
from typing import Any, Optional, Sequence, Tuple, Union
Expand Down
9 changes: 1 addition & 8 deletions tensorbay/cli/tbrn.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,7 @@
# Copyright 2021 Graviti. Licensed under MIT License.
#

"""TensorBay Resource Name (TBRN) related classes.
:class:`TBRNType` is an enumeration type, which has 7 types: 'DATASET', 'SEGMENT', 'FRAME',
'SEGMENT_SENSOR', 'FRAME_SENSOR', 'NORMAL_FILE' and 'FUSION_FILE'.
:class:`TBRN` is a TensorBay Resource Name(TBRN) parser and generator.
"""
"""Definitions of TensorBay Resource Name (TBRN) related classes."""

from enum import Enum, Flag, auto
from typing import Any, List, Optional, Tuple, TypeVar
Expand Down
2 changes: 1 addition & 1 deletion tensorbay/cli/utility.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Copyright 2021 Graviti. Licensed under MIT License.
#

"""Graviti Tensorbay gas CLI utility functions."""
"""TensorBay gas CLI utility functions."""

import logging
import os
Expand Down

0 comments on commit 20757e3

Please sign in to comment.