mirror of
https://github.com/hexedtech/codemp.git
synced 2024-11-22 07:14:50 +01:00
docs: python example and type hints
This commit is contained in:
parent
e5ffc7cac2
commit
66938cbaf0
2 changed files with 4 additions and 4 deletions
2
dist/py/src/codemp/codemp.pyi
vendored
2
dist/py/src/codemp/codemp.pyi
vendored
|
@ -24,7 +24,7 @@ class Config:
|
||||||
port: Optional[int]
|
port: Optional[int]
|
||||||
tls: Optional[bool]
|
tls: Optional[bool]
|
||||||
|
|
||||||
def __new__(cls, username: str, password: str, **kwargs) -> Config: ...
|
def __new__(cls, *, username: str, password: str, **kwargs) -> Config: ...
|
||||||
|
|
||||||
def init() -> Driver: ...
|
def init() -> Driver: ...
|
||||||
def set_logger(logger_cb: Callable[[str], None], debug: bool) -> bool: ...
|
def set_logger(logger_cb: Callable[[str], None], debug: bool) -> bool: ...
|
||||||
|
|
|
@ -83,8 +83,8 @@
|
||||||
//!
|
//!
|
||||||
//! # connect first, api.code.mp is managed by hexed.technology
|
//! # connect first, api.code.mp is managed by hexed.technology
|
||||||
//! client = codemp.connect(codemp.Config(
|
//! client = codemp.connect(codemp.Config(
|
||||||
//! username='mail@example.net',
|
//! username = "mail@example.net",
|
||||||
//! password='dont-use-this-password'
|
//! password = "dont-use-this-password"
|
||||||
//! )).wait()
|
//! )).wait()
|
||||||
//!
|
//!
|
||||||
//! # create and join a workspace
|
//! # create and join a workspace
|
||||||
|
@ -92,7 +92,7 @@
|
||||||
//! workspace = client.attach_workspace("some-workspace").wait()
|
//! workspace = client.attach_workspace("some-workspace").wait()
|
||||||
//!
|
//!
|
||||||
//! # create a new buffer in this workspace and attach to it
|
//! # create a new buffer in this workspace and attach to it
|
||||||
//! workspace.create("/my/file.txt").wait()
|
//! workspace.create_buffer("/my/file.txt").wait()
|
||||||
//! buffer = workspace.attach_buffer("/my/file.txt").wait()
|
//! buffer = workspace.attach_buffer("/my/file.txt").wait()
|
||||||
//!
|
//!
|
||||||
//! # write `hello!` at the beginning of this buffer
|
//! # write `hello!` at the beginning of this buffer
|
||||||
|
|
Loading…
Reference in a new issue