Skip to content

Commit

Permalink
docs: shorten section titles
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia committed Sep 24, 2023
1 parent fe6a331 commit cd906ff
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/quickstart.mld
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This tutorial is for an implementer to adopt this library as quickly as possible. We will assume you are already familiar with OCaml and are using a typical OCaml package structure.

{1 Define Error Codes and Create a Logger}
{1 Define Error Codes}

The first step is to create a file [Logger.ml] with the following template:

Expand Down Expand Up @@ -66,7 +66,7 @@ let () =
(* your application code *)
]}

{1 Adding Backtraces}
{1 Add Backtraces}

Great messages come with meaningful backtraces. To add backtraces, you will have to "annotate" your code to generate meaningful backtraces. Suppose this is one of the functions whose invocation should be noted in user-facing backtraces:
{[
Expand Down Expand Up @@ -95,6 +95,6 @@ let () =
(* your application code *)
]}

{1 Adding Location Information}
{1 Add Location Information}

Lots of functions in your [Logger] is taking the optional argument [loc], including {{!val:Asai.Logger.S.trace}trace}. It is expecting an argument of type {!type:Asai.Span.t}. If you are using OCamllex, perhaps you will find {{!val:Asai.Span.of_lex}of_lex} handy. Please take a look at {!module:Asai.Span} to learn how to work with spans.

0 comments on commit cd906ff

Please sign in to comment.