6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-12 16:26:40 +00:00
tutor/docs
Régis Behmo 33e4f33afe feat: strongly typed hooks
Now that the mypy bugs have been resolved, we are able to define more precisely
and cleanly the types of Actions and Filters.

Moreover, can now strongly type named actions and hooks (in consts.py). With
such a strong typing, we get early alerts of hooks called with incorrect
arguments, which is nothing short of awesome :)

This change breaks the hooks API by removing the `context=...` argument. The
reason for that is that we cannot insert arbitrary arguments between `P.args,
P.kwargs`: https://peps.python.org/pep-0612/#the-components-of-a-paramspec

> A function declared as def inner(a: A, b: B, *args: P.args, **kwargs:
> P.kwargs) -> R has type Callable[Concatenate[A, B, P], R]. Placing
> keyword-only parameters between the *args and **kwargs is forbidden.

Getting the documentation to build in nitpicky mode is quite difficult... We
need to add `nitpick_ignore` to the docs conf.py, otherwise sphinx complains
about many missing class references. This, despite upgrading almost all doc
requirements (except docutils).
2022-11-15 14:58:36 +01:00
..
_ext feat: migrate to plugins.v1 with filters & actions 2022-04-15 15:30:54 +02:00
download docs: wrap tutor[full] in quotes for zsh compatibility 2022-04-15 09:20:21 +02:00
img docs: reorganize local guides in tutorials 2021-10-14 12:59:57 +02:00
plugins v14.0.0: upgrade to Nutmeg 2022-06-09 19:18:20 +02:00
reference feat: strongly typed hooks 2022-11-15 14:58:36 +01:00
tutorials Remove warning about building tutor-mfe on ARM systems 2022-10-03 14:15:24 +02:00
_release_description.md ci: fix release description format 2022-04-24 15:09:16 +02:00
.gitignore Migrate openedx-docker project to Tutor 👩‍🏫 2018-12-26 19:27:08 +01:00
conf.py feat: strongly typed hooks 2022-11-15 14:58:36 +01:00
configuration.rst docs: add missing config parameters from defaults.yaml 2022-07-25 15:43:40 +02:00
dev.rst feat: default to ipdb as PYTHONBREAKPOINT 2022-06-22 11:26:50 +02:00
faq.rst v14.0.0: upgrade to Nutmeg 2022-06-09 19:18:20 +02:00
gettingstarted.rst feat: upgrade to Maple 2021-12-20 21:21:36 +01:00
index.rst docs: move forum to discuss.openedx.org 2022-05-23 09:48:19 +02:00
install.rst v14.0.0: upgrade to Nutmeg 2022-06-09 19:18:20 +02:00
intro.rst feat: introduce tutor dev quickstart 2022-04-19 16:53:57 +02:00
k8s.rst feat: Make it possible to customize k8s resources 2022-06-28 10:30:24 +02:00
local.rst Update local.rst 2022-10-03 14:09:34 +02:00
Makefile feat: strongly typed hooks 2022-11-15 14:58:36 +01:00
quickstart.rst v14.0.0: upgrade to Nutmeg 2022-06-09 19:18:20 +02:00
run.rst docs: build docs in CI (and be nitpicky about it) 2021-10-14 12:59:57 +02:00
testimonials.rst v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
troubleshooting.rst docs: add troubleshootoing docs for mysql connectivity errors 2022-09-12 06:38:44 +02:00
tutor.rst docs: move forum to discuss.openedx.org 2022-05-23 09:48:19 +02:00
whatnext.rst docs: move forum to discuss.openedx.org 2022-05-23 09:48:19 +02:00