On 21/09/14 16:54, Simon Peyton Jones via ghc-devs wrote:
Yes, exactly. Notes have evolved into such a compellingly useful part of GHC
that I really think they deserve Haddock support.
But here’s another tension: the Haddock for a function should be about the user
interface; its specification
> On 14 Sep 2021, at 8:29 am, Hécate wrote:
>
> I may have missed an episode or two here but what prevents us from writing
> Notes as Named Chunks¹, write them where Haddock expects you to put
> documentation, and refer to them from the relevant spot in the code?
> Viktor (in CC) has done a won
Sebastian Graf writes:
> What I don't like:
>
>- I can't refer to $chunk from other modules
>- Everywhere I reference $chunk in a haddock, it gets inlined instead of
>appearing with its title or inserting a link with the section name it is
>currently decoupled from.
>
It seems lik
:simo...@microsoft.com> will cease to work. Use
simon.peytonjo...@gmail.com<mailto:simon.peytonjo...@gmail.com> instead. (For
now, it just forwards to simo...@microsoft.com.)
From: ghc-devs On Behalf Of Sebastian Graf
Sent: 14 September 2021 15:00
To: Hécate
Cc: ghc-devs
Subject: R
Okay I see what you mean, thank you. :)
Le 14/09/2021 à 16:37, Sebastian Graf a écrit :
What I don't like:
* I have to give a section name to an otherwise unused $chunk
* I can't refer to $chunk from other modules
* Everywhere I reference $chunk in a haddock, it gets inlined
instead o
What I don't like:
- I have to give a section name to an otherwise unused $chunk
- I can't refer to $chunk from other modules
- Everywhere I reference $chunk in a haddock, it gets inlined instead of
appearing with its title or inserting a link with the section name it is
currently d
Hi,
The named chunks can be positioned through the use of the export list
syntax:
module Foo
( main
-- * Section name that will appear
--
-- $chunk
)
This should produce a free section that is not linked to any exported item.
I see you're already using them though, so maybe I am und
Hi,
I've been using Haddock's named chunks feature too when writing the docs
for selective lambda lifting.
This is the result:
https://hackage.haskell.org/package/ghc-8.10.2/docs/StgLiftLams.html, and
this is how the source code looks:
https://hackage.haskell.org/package/ghc-8.10.2/docs/src/StgLif
> today’s Haddock doesn’t understand Notes. But we could fix that if
we were minded to.
I may have missed an episode or two here but what prevents us from
writing Notes as Named Chunks¹, write them where Haddock expects you to
put documentation, and refer to them from the relevant spot in the
