mirror of
https://github.com/samschott/maestral.git
synced 2024-09-22 11:27:35 +03:00
further documentation improvements
This commit is contained in:
parent
8b60418470
commit
0bcedbe72a
@ -1,6 +1,9 @@
|
||||
maestral.cli
|
||||
============
|
||||
|
||||
Only the support function are documented here. Please refer to the source code and the
|
||||
user documentation for the actual commands.
|
||||
|
||||
.. automodule:: maestral.cli
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
@ -133,7 +133,8 @@ class AutoStartLaunchd(AutoStartBase):
|
||||
|
||||
:param bundle_id: Bundle ID for the, e.g., "com.google.calendar".
|
||||
:param start_cmd: Absolute path to executable and optional program arguments.
|
||||
:param **kwargs: Additional sections to plist.
|
||||
:param kwargs: Additional key, value pairs to add to plist. Values may be strings,
|
||||
booleans, lists or dictionaries.
|
||||
"""
|
||||
|
||||
def __init__(self, bundle_id: str, start_cmd: str, **kwargs) -> None:
|
||||
|
@ -1,8 +1,8 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
This file defines the functions to configure and interact with Maestral from the command
|
||||
line. Some imports are deferred to the functions that required them in order to reduce
|
||||
the startup time of individual CLI commands.
|
||||
This module defines the functions to configure and interact with Maestral from the
|
||||
command line. Some imports are deferred to the functions that required them in order to
|
||||
reduce the startup time of individual CLI commands.
|
||||
"""
|
||||
|
||||
# system imports
|
||||
@ -215,7 +215,7 @@ def check_for_fatal_errors(m: Union["MaestralProxy", "Maestral"]) -> bool:
|
||||
def convert_py_errors(func: Callable) -> Callable:
|
||||
"""
|
||||
Decorator that catches a MaestralApiError and prints a formatted error message to
|
||||
stdout before exiting.
|
||||
stdout before exiting. Calls ``sys.exit(1)`` after printing the error to stdout.
|
||||
"""
|
||||
|
||||
from .errors import MaestralApiError
|
||||
|
Loading…
Reference in New Issue
Block a user