return markdown headings to preserve structure

This commit is contained in:
Luke Boswell 2023-03-15 18:30:44 +11:00
parent 90dd31aaca
commit 2241b173bf
No known key found for this signature in database
GPG key ID: F6DB3C9DB47377B0
4 changed files with 9 additions and 7 deletions

View file

@ -34,7 +34,7 @@ interface Dict
## A [dictionary](https://en.wikipedia.org/wiki/Associative_array) that lets you
## associate keys with values.
##
## **Inserting**
## ## Inserting
##
## The most basic way to use a dictionary is to start with an empty one and
## then:
@ -54,7 +54,7 @@ interface Dict
## |> Dict.insert "Delhi" 16_787_941
## |> Dict.insert "Amsterdam" 872_680
## ```
## **Accessing keys or values**
## ## Accessing keys or values
##
## We can use [Dict.keys] and [Dict.values] functions to get only the keys or
## only the values.
@ -63,7 +63,7 @@ interface Dict
## order. This will be true if all you ever do is [Dict.insert] and [Dict.get] operations
## on the dictionary, but [Dict.remove] operations can change this order.
##
## **Removing**
## ## Removing
##
## We can remove an element from the dictionary, like so:
## ```

View file

@ -95,7 +95,7 @@ interface List
## Under the hood, a list is a record containing a `len : Nat` field, a `capacity : Nat`
## field, and a pointer to a reference count and a flat array of bytes.
##
## **Shared Lists**
## ## Shared Lists
##
## Shared lists are [reference counted](https://en.wikipedia.org/wiki/Reference_counting).
##

View file

@ -175,7 +175,7 @@ interface Num
## In this way, the [Num] type makes it possible to have `1 + 0x1` return
## `2 : Int *` and `1.5 + 1.5` return `3.0 : Frac`.
##
## **Number Literals**
## ## Number Literals
##
## Number literals without decimal points (like `0`, `4` or `360`)
## have the type `Num *` at first, but usually end up taking on
@ -951,7 +951,9 @@ pow : Frac a, Frac a -> Frac a
##
## Num.exp 5 6
## ```
## **Performance Note:** Be careful! It is very easy for this function to produce an answer
## ## Performance Details
##
## Be careful! It is very easy for this function to produce an answer
## so large it causes an overflow.
powInt : Int a, Int a -> Int a

View file

@ -1,5 +1,5 @@
##
## **Working with Unicode strings in Roc.**
## ## Working with Unicode strings in Roc
##
## Unicode can represent text values which span multiple languages, symbols, and emoji.
## Here are some valid Roc strings: