diff --git a/docs/api/sending_files.md b/docs/api/sending_files.md index 02e14599..ffdecf76 100644 --- a/docs/api/sending_files.md +++ b/docs/api/sending_files.md @@ -49,9 +49,9 @@ text_file = BufferedInputFile(b"Hello, world!", filename="file.txt") ### BufferedInputFile(...) |Argument|Type|Description| |---|---|---| -| buffer | `#!python3 bytes` | File path | -| filename | `#!python3 str` | Custom filename to be presented to Telegram (Required) | -| chunk_size | `#!python3 int` | File chunks size (Default: `64 kb`) | +| `buffer` | `#!python3 bytes` | File path | +| `filename` | `#!python3 str` | Custom filename to be presented to Telegram (Required) | +| `chunk_size` | `#!python3 int` | File chunks size (Default: `64 kb`) | Also you can read buffer from file: @@ -62,6 +62,6 @@ file = BufferedInputFile.from_file("file.txt") ### BufferedInputFile.from_file(...) |Argument|Type|Description| |---|---|---| -| path | `#!python3 Union[str, Path]` | File path | -| filename | `#!python3 Optional[str]` | Custom filename to be presented to Telegram | -| chunk_size | `#!python3 int` | File chunks size (Default: `64 kb`) | +| `path` | `#!python3 Union[str, Path]` | File path | +| `filename` | `#!python3 Optional[str]` | Custom filename to be presented to Telegram | +| `chunk_size` | `#!python3 int` | File chunks size (Default: `64 kb`) | diff --git a/docs/index.md b/docs/index.md index 3837d9f6..55668f45 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ Documentation for version 3.0 [WIP] [^1] ## Features - Asynchronous -- [Supports Telegram Bot API v2.4](api/index.md) +- [Supports Telegram Bot API v4.4](api/index.md) - Finite State Machine - [Replies into Webhook](https://core.telegram.org/bots/faq#how-can-i-make-requests-in-response-to-updates) - Middlewares diff --git a/docs/install.md b/docs/install.md index c7b3ae26..5cb143cb 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,6 +1,6 @@ # Installation Guide -## Stable +## Stable (2.x) ### Using PIP ```bash pip install -U aiogram @@ -20,11 +20,11 @@ poetry add aiogram *aiogram* is also available in Arch User Repository, so you can install this library on any Arch-based distribution like ArchLinux, Antergos, Manjaro, etc. To do this, use your favorite AUR-helper and install [python-aiogram](https://aur.archlinux.org/packages/python-aiogram/) package. -## Development build +## Development build (3.x) ### From private PyPi index On every push to the `dev-3.x` branch GitHub Actions build the package and publish to the [2038.host](https://aiogram.2038.io/simple) server with seems like official PyPi files structure. That's mean you can always install latest (may be unstable) build via next command: ```bash pip install --extra-index-url https://aiogram.2038.io/simple --pre aiogram ``` -In this repository available only last release. All previous builds is always removes before uploading new one. Also before building this package all tests is also pass. +In this repository available only last success build. All previous builds is always removes before uploading new one. Also before building this package all tests is also pass.