I have the following code:

-- | The datatype that represents an infinite list. The two type arguments are:
-- |
-- | * `a`: The type that will be returned by the getter methods.
-- | * `b`: The base type for this infinite list that is being iterated over.
data InfiniteList b a = IL (b -> a) (b -> b) b

-- | ### Generators

-- | Generate an infinite list by providing:
-- |
-- |  * a function to iterate from the previous value in the infinite list to the next AND
-- |  * the first element in the infinite list to begin the iteration.
-- |
-- | For example, to generate the list of natural numbers you can do the following:
-- |
-- |     naturals = iterate ((+) 1) 1
-- |
-- | In english, "The natural numbers start at 1 and you can get the next natural
-- | number by adding one to the prior number".
-- |
-- | Running time: `O(1)`
iterate :: forall a. (a -> a) -> a -> InfiniteList a a
iterate iter start = IL id iter start

I expect the generated docs to have the heading for "Generators" to appear before the iterate documentation. Instead this is the generated markdown:

``` purescript
data InfiniteList b a
```

The datatype that represents an infinite list. The two type arguments are:

* `a`: The type that will be returned by the getter methods.
* `b`: The base type for this infinite list that is being iterated over.

##### Instances
``` purescript
Functor (InfiniteList a)
Filterable (InfiniteList a)
```

#### `iterate`

``` purescript
iterate :: forall a. (a -> a) -> a -> InfiniteList a a
```

### Generators
Generate an infinite list by providing:

 * a function to iterate from the previous value in the infinite list to the next AND
 * the first element in the infinite list to begin the iteration.

For example, to generate the list of natural numbers you can do the following:

    naturals = iterate ((+) 1) 1

In english, "The natural numbers start at 1 and you can get the next natural
number by adding one to the prior number".

Running time: `O(1)`

As you can see, the "Generators" heading is considered to be inside the "iterate" function. Which is not what I want. Is there a way to get the "### Generators" heading to appear outside of the iterate function? That is what this issue is about: getting headings outside of specific purescript function documentation.

Edit: For more clarity, his is the Markdown output that I want to see:

``` purescript
data InfiniteList b a
```

The datatype that represents an infinite list. The two type arguments are:

* `a`: The type that will be returned by the getter methods.
* `b`: The base type for this infinite list that is being iterated over.

##### Instances
``` purescript
Functor (InfiniteList a)
Filterable (InfiniteList a)
```

### Generators

#### `iterate`

``` purescript
iterate :: forall a. (a -> a) -> a -> InfiniteList a a
```

Generate an infinite list by providing:

 * a function to iterate from the previous value in the infinite list to the next AND
 * the first element in the infinite list to begin the iteration.

For example, to generate the list of natural numbers you can do the following:

    naturals = iterate ((+) 1) 1

In english, "The natural numbers start at 1 and you can get the next natural
number by adding one to the prior number".

Running time: `O(1)`

It would even be great if we could add text to the "Generators" heading; the equivalent of a section comment.

Allow documentation structure like Haddock does. #2525

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions