GHC proposals not rendering

[Adam Gundry]

On 22/01/2024 16:15, Simon Peyton Jones wrote:
> Is there any workaround at all?   E.g. a web site where you can give it 
> a URL for a RST file,  and it'll typeset the RST for you?  Or is it 
> impossible to to typeset RST?

I tend to use pandoc to preview RST files locally. There are also a few 
websites that allow you to enter RST content directly and see a live 
preview (e.g. https://snippets.documatt.com/). They may not exactly line 
up with how GitHub renders things, of course, and I don't know of any 
that let you feed in a URL to an RST file hosted elsewhere.

Adam


> On Mon, 22 Jan 2024 at 13:22, Bryan Richter via ghc-devs 
> <ghc-devs at haskell.org <mailto:ghc-devs at haskell.org>> wrote:
> 
>     I cataloged all the proposals that fail to render. The others are ok.
> 
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0111-linear-types.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0111-linear-types.rst>
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0281-visible-forall.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0281-visible-forall.rst>
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0378-dependent-type-design.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0378-dependent-type-design.rst>
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0380-ghc2021.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0380-ghc2021.rst>
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0448-type-variable-scoping.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0448-type-variable-scoping.rst>
>     https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0583-hasfield-redesign.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0583-hasfield-redesign.rst>
> 
> 
> 
>     On Mon, 22 Jan 2024 at 11:56, Joachim Breitner
>     <mail at joachim-breitner.de <mailto:mail at joachim-breitner.de>> wrote:
> 
>         Hi,
> 
>         it’s not simply file size: we have (from wc -c proposals/*|sort -n)
> 
>            43501 proposals/0380-ghc2021.rst
>            44051 proposals/0242-unsaturated-type-families.rst
> 
>         but #380 doesn't work but #242 works.
> 
>         I tried some rst linters, but nothing popped up.
> 
>         It could be output size or render time: It loading the file does
>         take a
>         while, as if github tries to render it and then gives up.
> 
>         That’s quite annoying, not sure what to do here now.
> 
>         Cheers,
>         Joachim
> 
> 
>         Am Freitag, dem 19.01.2024 um 14:16 +0200 schrieb Bryan Richter via
>         ghc-devs:
>          > I'm guessing GitHub had to limit the size of .rst files that
>         get rendered. I can imagine the kinds of annoying security or
>         abuse issues they might be working around...
>          >
>          > The smallest file that doesn't work that I found by clicking
>         around:
>         https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0380-ghc2021.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0380-ghc2021.rst> (42KB)
>          >
>          > The largest that does still work:
>         https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0581-namespace-specified-imports.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0581-namespace-specified-imports.rst> (25KB)
>          >
>          > On Fri, 12 Jan 2024 at 14:49, Simon Peyton Jones
>         <simon.peytonjones at gmail.com
>         <mailto:simon.peytonjones at gmail.com>> wrote:
>          > > But it used to work fine. What has changed?  It seems like
>         a pretty serious bug!
>          > >
>          > > On Thu, 11 Jan 2024 at 15:38, Rodrigo Mesquita
>         <rodrigo.m.mesquita at gmail.com
>         <mailto:rodrigo.m.mesquita at gmail.com>> wrote:
>          > > > FWIW, I’m able to render/preview successfully other
>         proposals, but 448-type-variable-scoping loads very slowly and
>         ultimately fails to render for me too.
>          > > >
>          > > > A comment in https://github.com/github/markup/issues/1016
>         <https://github.com/github/markup/issues/1016> (issue related to
>         .rst not rendering) says that forcing a change in the file
>         triggered a re-render successfully.
>          > > >
>          > > > Rodrigo
>          > > >
>          > > >
>          > > > > On 11 Jan 2024, at 15:28, Simon Peyton Jones
>         <simon.peytonjones at gmail.com
>         <mailto:simon.peytonjones at gmail.com>> wrote:
>          > > > >
>          > > > > If you go to
>         https://github.com/ghc-proposals/ghc-proposals/pull/448
>         <https://github.com/ghc-proposals/ghc-proposals/pull/448>, and
>         click on the "rendered" link, namely
>         https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0448-type-variable-scoping.rst <https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0448-type-variable-scoping.rst>, Github is now displaying the .rst source, not the rendered proposal.
>          > > > >
>          > > > > This has started happening (consistently across other
>         proposals) today.
>          > > > >
>          > > > > Does anyone know why?  How can I fix this?
>          > > > >
>          > > > > Simon

-- 
Adam Gundry, Haskell Consultant
Well-Typed LLP, https://www.well-typed.com/

Registered in England & Wales, OC335890
27 Old Gloucester Street, London WC1N 3AX, England