python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-12 02:03:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Small changes in api docs.

Browse source
This commit is contained in:
jrootjunior 2019-12-03 13:12:39 +02:00
parent aa7c5796dd
commit ea7b20e114
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/index.md
View file

@ -2,19 +2,19 @@
**aiogram** now is fully support of [Telegram Bot API v4.4](https://core.telegram.org/bots/api) **aiogram** now is fully support of [Telegram Bot API v4.4](https://core.telegram.org/bots/api)
All API methods and types is fully autogenerated from Telegram Bot API docs by parser with code-generator All API methods and types is fully autogenerated from Telegram Bot API docs by parser with code-generator.
Package: `aiogram.api` Package: `aiogram.api`
## Methods ## Methods
All API methods is wrapped as **pydantic** models and placed in `aiogram.api.methods` package so that's mean all values which you pass as arguments to the methods will be validated. All API methods is wrapped as [pydantic](https://pydantic-docs.helpmanual.io/) models and placed in `aiogram.api.methods` package so that's mean all values which you pass as arguments to the methods will be validated.
Here is all methods is classes and in due to Python standards all classes named in upper camel case, for example methods `sendMessage` has the name `SendMessage` Here is all methods is classes and in due to Python standards all classes named in upper camel case, for example methods `sendMessage` has the name `SendMessage`
Also in places where you can send Also in places where you can send
## Types ## Types
All types is also wrapped with **pydantic** and placed in `aiogram.api.types` package. All types is also wrapped with [pydantic](https://pydantic-docs.helpmanual.io/) and placed in `aiogram.api.types` package.
In this place makes some more differences with official documentations: In this place makes some more differences with official documentations:
- name `from` was renamed to `from_user` in due to `from` is an keyword in python - name `from` was renamed to `from_user` in due to `from` is an keyword in python