Move TODO to external page in docs

This commit is contained in:
jrootjunior 2020-01-30 18:02:23 +02:00
parent fcb8a414e9
commit 5daf3b2162
3 changed files with 60 additions and 38 deletions

View file

@ -46,7 +46,7 @@ dp = Dispatcher()
@dp.message_handler(commands=["start"])
class MyHandler(MessageHandler):
"""
This handler receive messages with /start command
This handler receive messages with `/start` command
"""
async def handle(self):
@ -73,41 +73,6 @@ if __name__ == "__main__":
```
## Task list for 3.0
- [ ] Telegram API features
- [x] Rewrite Telegram types using **pydantic**
- [x] Rewrite Telegram methods using **pydantic**
- [x] Rewrite bot class
- [ ] Contextual aliases for methods in types
- [ ] ...
- [ ] Dispatcher features
- [x] Blueprints/Routers
- [ ] Refactor FSM
- [ ] Refactor filters
- [ ] Middlewares
- [ ] Tests
- [x] API
- [x] Sessions
- [x] Types
- [x] Methods
- [x] Client
- [ ] Dispatcher
- [ ] Dispatcher
- [x] Router
- [x] Observers
- [ ] Filters
- [ ] Utils
- [x] Helper
- [x] Markdown/HTML
- [ ] ...
- [ ] CI/CD
- [ ] Publish to PyPi on tag
- [x] Build docs on push
- [x] Code style
- [x] Test with coverage on pull-request
- [x] Test with coverage on push
- [x] mypy on pull-request
- [x] Flake8 on pull-request
Partial list of plans for this big release is listed [here](todo.md).
[^1]: work in progress

56
docs/todo.md Normal file
View file

@ -0,0 +1,56 @@
# TODO
!!! warning
Here is lister not all tasks
- [ ] Telegram API features
- [x] Rewrite Telegram types using **pydantic**
- [x] Rewrite Telegram methods using **pydantic**
- [x] Rewrite bot class
- [ ] Contextual aliases for methods in types
- [ ] ...
- [ ] Dispatcher features
- [x] Blueprints/Routers
- [ ] Refactor FSM
- [ ] Engine
- [ ] Builtin storage's
- [ ] ...
- [ ] Refactor filters
- [ ] Engine
- [ ] Builtin filters
- [x] Command
- [x] ContentTypes
- [x] Text
- [ ] ...
- [ ] Middlewares
- [ ] Engine
- [ ] Builtin middlewares
- [ ] ...
- [ ] Webhook
- [ ] Executor
- [ ] i18n
- [ ] ...
- [ ] Tests
- [x] API
- [x] Sessions
- [x] Types
- [x] Methods
- [x] Client
- [ ] Dispatcher
- [x] Dispatcher
- [x] Router
- [x] Observers
- [ ] Filters
- [ ] Utils
- [x] Helper
- [x] Markdown/HTML
- [ ] ...
- [ ] CI/CD
- [ ] Publish to PyPi on tag
- [x] Build docs on push
- [x] Code style
- [x] Test with coverage on pull-request
- [x] Test with coverage on push
- [x] mypy on pull-request
- [x] Flake8 on pull-request

View file

@ -17,7 +17,7 @@ theme:
logo: 'assets/images/logo.png'
extra:
version: 3.0.0a0
version: 3.0.0a2
plugins:
- search
@ -243,6 +243,7 @@ nav:
- dispatcher/class_based_handlers/poll.md
- dispatcher/class_based_handlers/pre_checkout_query.md
- dispatcher/class_based_handlers/shipping_query.md
- todo.md
- Build reports:
- reports.md
- Tests result: /reports/tests