[new release] odoc-parser (1.0.0)

[jonludlam]

Parser for ocaml documentation comments

• Project page: https://github.com/ocaml-doc/odoc-parser
• Documentation: https://ocaml-doc.github.io/odoc-parser/

CHANGES:

• New syntax to allow associating metadata with code blocks
  (@Julow, Parse code blocks metadata ocaml-doc/odoc-parser#2, Strip whitespaces from the end of the metadata field ocaml-doc/odoc-parser#3)

[kit-ty-kate]

For posterity:

#=== ERROR while compiling ocamlformat.0.20.0 =================================#
# context              2.0.10 | linux/x86_64 | ocaml-base-compiler.4.13.1 | file:///home/opam/opam-repository
# path                 ~/.opam/4.13/.opam-switch/build/ocamlformat.0.20.0
# command              ~/.opam/opam-init/hooks/sandbox.sh build dune build -p ocamlformat -j 31 @install
# exit-code            1
# env-file             ~/.opam/log/ocamlformat-8060-e7966f.env
# output-file          ~/.opam/log/ocamlformat-8060-e7966f.out
### output ###
#     ocamlopt lib/.ocamlformat_lib.objs/native/ocamlformat_lib__Normalize.{cmx,o} (exit 2)
# (cd _build/default && /home/opam/.opam/4.13/bin/ocamlopt.opt -w -40 -noassert -open Ocaml_common -open Ocaml_413_extended -open Ocamlformat_stdlib -g -I lib/.ocamlformat_lib.objs/byte -I lib/.ocamlformat_lib.objs/native -I /home/opam/.opam/4.13/lib/astring -I /home/opam/.opam/4.13/lib/base -I /home/opam/.opam/4.13/lib/base/base_internalhash_types -I /home/opam/.opam/4.13/lib/base/caml -I /home/opam/.opam/4.13/lib/base/shadow_stdlib -I /home/opam/.opam/4.13/lib/bytes -I /home/opam/.opam/4.13/lib/cmdliner -I /home/opam/.opam/4.13/lib/dune-build-info -I /home/opam/.opam/4.13/lib/either -I /home/opam/.opam/4.13/lib/fpath -I /home/opam/.opam/4.13/lib/menhirLib -I /home/opam/.opam/4.13/lib/ocaml-version -I /home/opam/.opam/4.13/lib/ocaml/compiler-libs -I /home/opam/.opam/4.13/lib/ocp-indent/lexer -I /home/opam/.opam/4.13/lib/ocp-indent/lib -I /home/opam/.opam/4.13/lib/ocp-indent/utils -I /home/opam/.opam/4.13/lib/odoc-parser -I /home/opam/.opam/4.13/lib/re -I /home/opam/.opam/4.13/lib/result -I /home/opam/.opam/4.13/lib/seq -I /home/opam/.opam/4.13/lib/sexplib0 -I /home/opam/.opam/4.13/lib/stdio -I /home/opam/.opam/4.13/lib/uchar -I /home/opam/.opam/4.13/lib/uucp -I /home/opam/.opam/4.13/lib/uuseg -I /home/opam/.opam/4.13/lib/uuseg/string -I /home/opam/.opam/4.13/lib/uutf -I vendor/ocaml-4.13-extended/.ocaml_413_extended.objs/byte -I vendor/ocaml-4.13-extended/.ocaml_413_extended.objs/native -I vendor/ocaml-4.13/.ocaml_413.objs/byte -I vendor/ocaml-4.13/.ocaml_413.objs/native -I vendor/ocaml-common/.ocaml_common.objs/byte -I vendor/ocaml-common/.ocaml_common.objs/native -I vendor/ocamlformat-stdlib/.ocamlformat_stdlib.objs/byte -I vendor/ocamlformat-stdlib/.ocamlformat_stdlib.objs/native -I vendor/ocamlformat_support/.format_.objs/byte -I vendor/ocamlformat_support/.format_.objs/native -I vendor/parse-wyc/lib/.parse_wyc.objs/byte -I vendor/parse-wyc/lib/.parse_wyc.objs/native -I vendor/parser-shims/.parser_shims.objs/byte -I vendor/parser-shims/.parser_shims.objs/native -intf-suffix .ml -no-alias-deps -open Ocamlformat_lib -o lib/.ocamlformat_lib.objs/native/ocamlformat_lib__Normalize.cmx -c -impl lib/Normalize.ml)
# File "lib/Normalize.ml", line 196, characters 40-43:
# 196 |       odoc_nestable_block_element c fmt elm
#                                               ^^^
# Error: This expression has type
#          [> Odoc_parser.Ast.nestable_block_element ] =
#            [> `Code_block of
#                 (string Odoc_parser.Ast.with_location *
#                  string Odoc_parser.Ast.with_location option)
#                 option * string Odoc_parser.Ast.with_location
#             | `List of
#                 [ `Ordered | `Unordered ] * [ `Heavy | `Light ] *
#                 Odoc_parser.Ast.nestable_block_element
#                 Odoc_parser.Ast.with_location list list
#             | `Modules of
#                 Ocamlformat_stdlib.String.t Odoc_parser.Ast.with_location
#                 list
#             | `Paragraph of
#                 Odoc_parser.Ast.inline_element Odoc_parser.Ast.with_location
#                 list
#             | `Verbatim of Ocamlformat_stdlib.String.t ]
#        but an expression was expected of type
#          [< `Code_block of
#               Ocamlformat_stdlib.String.t Odoc_parser.Loc.with_location
#               option *
#               Ocamlformat_stdlib.string Odoc_parser.Loc.with_location
#           | `List of
#               [ `Ordered | `Unordered ] * [ `Heavy | `Light ] *
#               Odoc_parser.Ast.nestable_block_element
#               Odoc_parser.Ast.with_location list list
#           | `Modules of
#               Ocamlformat_stdlib.String.t Odoc_parser.Ast.with_location list
#           | `Paragraph of
#               Odoc_parser.Ast.inline_element Odoc_parser.Ast.with_location
#               list
#           | `Verbatim of Ocamlformat_stdlib.String.t
#           > `Modules `Paragraph `Verbatim ]
#          as 'a
#        Type
#          Odoc_parser.Ast.nestable_block_element Odoc_parser.Ast.with_location
#            =
#            Odoc_parser.Ast.nestable_block_element
#            Odoc_parser.Loc.with_location
#        is not compatible with type
#          'a Odoc_parser.Loc.with_location =
#            Odoc_parser.Ast.nestable_block_element
#            Odoc_parser.Loc.with_location 
#        Type
#          Odoc_parser.Ast.nestable_block_element =
#            [ `Code_block of
#                (string Odoc_parser.Ast.with_location *
#                 string Odoc_parser.Ast.with_location option)
#                option * string Odoc_parser.Ast.with_location
#            | `List of
#                [ `Ordered | `Unordered ] * [ `Heavy | `Light ] *
#                Odoc_parser.Ast.nestable_block_element
#                Odoc_parser.Ast.with_location list list
#            | `Modules of
#                Ocamlformat_stdlib.String.t Odoc_parser.Ast.with_location list
#            | `Paragraph of
#                Odoc_parser.Ast.inline_element Odoc_parser.Ast.with_location
#                list
#            | `Verbatim of Ocamlformat_stdlib.String.t ]
#        is not compatible with type
#          [< `Code_block of
#               Ocamlformat_stdlib.String.t Odoc_parser.Loc.with_location
#               option *
#               Ocamlformat_stdlib.string Odoc_parser.Loc.with_location
#           | `List of
#               [ `Ordered | `Unordered ] * [ `Heavy | `Light ] *
#               Odoc_parser.Ast.nestable_block_element
#               Odoc_parser.Ast.with_location list list
#           | `Modules of
#               Ocamlformat_stdlib.String.t Odoc_parser.Ast.with_location list
#           | `Paragraph of
#               Odoc_parser.Ast.inline_element Odoc_parser.Ast.with_location
#               list
#           | `Verbatim of Ocamlformat_stdlib.String.t
#           > `Modules `Paragraph `Verbatim ]
#          as 'a 
#        Type
#          string Odoc_parser.Ast.with_location *
#          string Odoc_parser.Ast.with_location option
#        is not compatible with type
#          Ocamlformat_stdlib.String.t Odoc_parser.Loc.with_location 
#        Types for tag `Code_block are incompatible

[kit-ty-kate]

Thanks!