You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The comments of functions imported with include/open Foo are incorrect.
Examples:
In CCRandom.ml:
open CCShims_
include Random ...
$ ocp-index print CCRandom.init
CCRandom.init val int -> unit
[flat_map f g st] is [f (g st) st].
Instead of:
$ ocp-index print Random.init
Stdlib__random.init val int -> unit
Initialize the generator, using the argument as a seed.
The same seed will always yield the same sequence of numbers.
In CCList.ml:
open CCShims_ ...
$ ocp-index print CCList.hd
CCList.hd val 'a list -> 'a
Like [append].
Concatenate two lists.
Instead of:
$ ocp-index print List.hd
Stdlib__list.hd val 'a list -> 'a
Return the first element of the given list. Raise
[Failure "hd"] if the list is empty.
In b00_std.ml:
module Char = struct
include Char ...
$ ocp-index print B00_std.Char.compare
B00_std.Char.compare val t -> t -> int
[cap tty] determines [tty]'s capabilities.
{1:style ANSI escapes and styling}
Instead of:
$ ocp-index print Char.compare
Stdlib__char.compare val t -> t -> int
The comparison function for characters, with the same specification as
{!Stdlib.compare}. Along with the type [t], this function [compare]
allows the module [Char] to be passed as argument to the functors
{!Set.Make} and {!Map.Make}.
The text was updated successfully, but these errors were encountered:
Fourchaux
changed the title
Incorrect docstrings for several Containers Modules (CCString, CCList, CCArray)
Incorrect docstrings of functions imported with include/open Foo
Jul 23, 2020
Docstrings are different but (still) incorrect:
e.g. with Containers:
$ ocp-index print CCList.hd
CCList.hd val 'a list -> 'a
[fold_while f init l] folds until a stop condition via [('a, `Stop)] is
indicated by the accumulator.
@since 0.8
Tests with: OCaml 4.10.0+flambda - Containers 2.8.1 (opam version) - b0 0.0.1 (opam version) - ocp-index 1.2 (opam version)
The comments of functions imported with include/open Foo are incorrect.
Examples:
The text was updated successfully, but these errors were encountered: