Open tomjaguarpaw opened 1 year ago
The 404 page for an error that matches the error code regex directs people towards the easiest paths to contribute it. Why would stub pages be better?
Because search engines don't index 404 pages, and the way I expect most users to get to the error code pages via search engines! To go into more detail on my experience:
GHC-32850
I think the experience would be a lot better if I could get to the stub pages via both 3 and 5.
I find your arguments convincing.
Would you like to send a PR?
Would you like to send a PR?
I would! It's on my mental stack of things to do, but I won't be offended if someone gets to it before me.
I just experienced exactly this confusion with the GHC-54201
error code.
Edit: This GHC issue seems related: https://gitlab.haskell.org/ghc/ghc/-/issues/23626
For the record, this is now so far off my mental stack of things to do that it may as well be considered not on it any more :) If someone can tackle it instead I will be grateful.
I just experienced exactly this confusion with the
GHC-54201
error code.Edit: This GHC issue seems related: https://gitlab.haskell.org/ghc/ghc/-/issues/23626
Based on the work by @sheaf in the mentioned GHC ticket, these are all the GHC error codes:
It seems 552 out of 649 (about 85%) are missing documentation.
What should the stub pages look like @david-christiansen?
In #473 I tried generating them to look like the "Not found" page, with just a little extra info to make it clear it is a known GHC error code.
I tried doing this manually by building current head GHC and running this:
_build/stage1/bin/ghc -package ghc --interactive
:m +GHC.Types.Error GHC.Driver.Errors.Types GHC.Driver.Errors.Ppr GHC.Types.Error.Codes Data.Map
mapM_ (\(c, t) -> putStrLn $ show c ++ ":" ++ t) (toList $ constructorCodes @GhcMessage)
And then I used a shell script to create the missing files:
If anyone has a better way with some JS/Haskell scripting so we can only have one file listing all known GHC codes, that would be great.
Probably best to ping @BinderDavid, as he is now in charge since David C has moved on from the HF.
Thanks, I somehow missed this issue.. I will take a closer look this weekend.
A user posted an error message containing an error code. It just so happens that it's
GHC-32850
(although the specific code doesn't matter for this issue). Google returns exactly one result for"GHC-32850"
which is a GHC GitLab issue containing a similar error message.I was surprised. I expected there to be a page for the error code in question, even if it says "this error message is not yet documented". In fact, that seems like an essential workflow for inexperienced users. Googling the code and getting no useful hits means that they haven't been helped by the index at all. On the other hand, if Google returns a link to a stub page that says "This error code is undocumented: please click here to file a GitHub issue to request documentation" that's really helpful!
So,