diff --git a/tensorbay/cli/__init__.py b/tensorbay/cli/__init__.py index 65c3a9d3e..93e9ebb2a 100644 --- a/tensorbay/cli/__init__.py +++ b/tensorbay/cli/__init__.py @@ -3,4 +3,4 @@ # Copyright 2021 Graviti. Licensed under MIT License. # -"""Graviti TensorBay CLI.""" +"""TensorBay CLI.""" diff --git a/tensorbay/cli/cli.py b/tensorbay/cli/cli.py index 4233f23c7..f974237b3 100644 --- a/tensorbay/cli/cli.py +++ b/tensorbay/cli/cli.py @@ -4,33 +4,7 @@ # # pylint: disable=import-outside-toplevel -"""Command-line interface. - -Use ``gas `` 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 diff --git a/tensorbay/cli/custom.py b/tensorbay/cli/custom.py index fd2a7bd83..2291efcf9 100644 --- a/tensorbay/cli/custom.py +++ b/tensorbay/cli/custom.py @@ -4,7 +4,7 @@ # # pylint: disable=import-outside-toplevel -"""Subclass declaration and definition of click class.""" +"""Customization of the click classes for TensorBay CLI.""" from types import MethodType from typing import Any, Optional, Sequence, Tuple, Union diff --git a/tensorbay/cli/tbrn.py b/tensorbay/cli/tbrn.py index 8a488e117..12ab263dc 100644 --- a/tensorbay/cli/tbrn.py +++ b/tensorbay/cli/tbrn.py @@ -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 diff --git a/tensorbay/cli/utility.py b/tensorbay/cli/utility.py index e78686b83..988cf2ab6 100644 --- a/tensorbay/cli/utility.py +++ b/tensorbay/cli/utility.py @@ -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