Skip to content

Commit faceb54

Browse files
committed
fix doc
1 parent 20b4304 commit faceb54

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

ghcide/src/Development/IDE/Core/ProgressReporting.hs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,13 @@ instance ProgressReportingClass (ProgressReporting m) where
8383
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8484
The progress of tasks can be tracked in two ways:
8585
86-
1. `InProgressState`: This is an internal state that actively tracks the progress.
86+
1. `ProgressReporting`: we have an internal state that actively tracks the progress.
8787
Changes to the progress are made directly to this state.
8888
89-
2. `InProgressStateOutSide`: This is an external state that tracks the progress.
89+
2. `ProgressReportingNoTrace`: there is an external state that tracks the progress.
9090
The external state is converted into an STM Int for the purpose of reporting progress.
9191
92-
The `inProgress` function is only useful when we are using `InProgressState`.
93-
94-
An alternative design could involve using GADTs to eliminate this discrepancy between
95-
`InProgressState` and `InProgressStateOutSide`.
92+
The `inProgress` function is only useful when we are using `ProgressReporting`.
9693
-}
9794

9895
noProgressReportingNoTrace :: (MonadUnliftIO m) => (ProgressReportingNoTrace m)

0 commit comments

Comments
 (0)