diff options
| author | sheaf <sam.derbyshire@gmail.com> | 2022-05-11 13:17:41 +0200 |
|---|---|---|
| committer | Matthew Pickering <matthewtpickering@gmail.com> | 2022-06-15 17:25:56 +0100 |
| commit | 931e19ed3bf54ac1e26af7325ea9080c19ae12f0 (patch) | |
| tree | 6d10643db0000001985a0383e4b34771b59bb3eb | |
| parent | 2ffcc97ed690c880db70f60d510546488e25b413 (diff) | |
| download | haskell-931e19ed3bf54ac1e26af7325ea9080c19ae12f0.tar.gz | |
Update extending_ghc for TcPlugin changes
The documentation still mentioned Derived constraints and
an outdated datatype TcPluginResult.
(cherry picked from commit 3bf938b6c5e1190f3a55e149deaec2f6309d398f)
| -rw-r--r-- | docs/users_guide/extending_ghc.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/users_guide/extending_ghc.rst b/docs/users_guide/extending_ghc.rst index 60f5749fb0..c64a66fb69 100644 --- a/docs/users_guide/extending_ghc.rst +++ b/docs/users_guide/extending_ghc.rst @@ -652,8 +652,8 @@ The key component of a typechecker plugin is a function of type :: - solve :: EvBindsVar -> [Ct] -> [Ct] -> [Ct] -> TcPluginM TcPluginResult - solve binds givens deriveds wanteds = ... + solve :: EvBindsVar -> [Ct] -> [Ct] -> TcPluginM TcPluginResult + solve binds givens wanteds = ... This function will be invoked in two different ways: @@ -679,8 +679,8 @@ i.e. in (1) it should return only Givens, and for (2) it should return only Wanteds; all other constraints will be ignored. If the plugin cannot make any progress, it should return -``TcPluginSolveResult [] [] []``. Otherwise, if there were any new constraints, the -main constraint solver will be re-invoked to simplify them, then the +``TcPluginSolveResult [] [] []``. Otherwise, if there were any new constraints, +the main constraint solver will be re-invoked to simplify them, then the plugin will be invoked again. The plugin is responsible for making sure that this process eventually terminates. |