Incorrect docstring on 4.06

[copy]

See c-cube/ocaml-containers#168. The .mli is include module type of String.

[Drup]

I can't reproduce the failure either. Do you have the issue with both normal and flambda compilers ?

[copy]

I can reproduce it on 4.06.1 with containers 2.0+alpha2:

┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── kinds: t, v, e, c, m, s, k ┐
│CCString.escaped                                                                                                                                                                    │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
> val CCString.escaped string -> string                                                                                                                                               
    [find_all ~sub s] finds all occurrences of [sub] in [s], even overlapping                                                                                                         
    instances.                                                                                                                                                                        
    @param start starting position in [s].                                                                                                                                            
    @since 0.17                                                                                                                                                                       

And slightly different on OCaml 4.06.1+flambda with Containers 2.1:

┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── kinds: t, v, e, c, m, s, k ┐
│CCString.esc                                                                                                                                                                        │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
> val CCString.escaped string -> string                                                                                                                                               
    [suffix ~suf s] returns [true] iff [suf] is a suffix of [s].                                                                                                                      
    @since 0.7                                                                                                                                                                        

And also some other functions:

┌──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── kinds: t, v, e, c, m, s, k ┐
│CCString.uncapitalize                                                                                                                                                               │
└────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
  val CCString.uncapitalize_ascii string -> string                                                                                                                                    
> val CCString.uncapitalize string -> string                                                                                                                                          
    All pairs of chars respect the predicate?                                                                                                                                         
    @raise Invalid_argument if the strings have not the same length.                                                                                                                  
    @since 0.12                                                                                                                                                                       

The pattern seems to be that all functions that aren't shadowed by containers have an incorrect docstring.

[Drup]

Which version of ocp-browser are you using. Can you reproduce on containers 2.1 as well ?

[copy]

Yes, I can reproduce with ocp-browser 1.1.6 and containers 2.1 on OCaml 4.06.1+flambda.

[Drup]

Ah! I can reproduce with 2.1 on 4.06.0 and 4.06.1+flambda, but on 4.04.2 and 4.05.0, included functions don't have any documentation at all. The plot thicken.