From 5daf3b2162b4fb794eeb0fd00c7c6f2104551dde Mon Sep 17 00:00:00 2001 From: jrootjunior Date: Thu, 30 Jan 2020 18:02:23 +0200 Subject: [PATCH] Move TODO to external page in docs --- docs/index.md | 39 ++--------------------------------- docs/todo.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 3 ++- 3 files changed, 60 insertions(+), 38 deletions(-) create mode 100644 docs/todo.md diff --git a/docs/index.md b/docs/index.md index c5652793..6961a181 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 diff --git a/docs/todo.md b/docs/todo.md new file mode 100644 index 00000000..02c99d9a --- /dev/null +++ b/docs/todo.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index f3b5f44d..c5b69163 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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