ocaml-batteries-team / batteries-included

Batteries Included project
http://ocaml-batteries-team.github.com/batteries-included/hdoc2/
Other
518 stars 106 forks source link

BatString.split_on_string since 2.11? #1122

Open jmid opened 11 months ago

jmid commented 11 months ago

The documentation for BatString.split_on_string says @since 2.11.0 https://github.com/ocaml-batteries-team/batteries-included/blob/master/src/batString.mli#L798

However I couldn't find any mention of it in https://github.com/ocaml-batteries-team/batteries-included/blob/v2.11.0/src/batString.mliv and on the CI run for this opam-repo PR ocaml complained about it with # Error: Unbound value BatString.split_on_string https://opam.ci.ocaml.org/github/ocaml/opam-repository/commit/2cf1ce6a52fb08f0fadcc6cbf13ad64f6ce4d684/variant/compilers,4.09,lbvs_consent.2.1.2,lower-bounds

I suspect, the documentation should just say @since 3.0.0 instead.

UnixJunkie commented 11 months ago

Can you check in the changelog file since which release it is mentioned?

jmid commented 11 months ago

There are only two mentions of split_on_string in the changelog - and both are bugfixes (in 3.7.1 and in 3.6.0).

UnixJunkie commented 11 months ago

We can git blame BatString.mli or the former BatString.mliv files to be sure.

On Fri, Oct 27, 2023 at 3:06 PM Jan Midtgaard @.***> wrote:

There are only two mentions of split_on_string in the changelog - and both are bugfixes (in 3.7.1 and in 3.6.0).

— Reply to this email directly, view it on GitHub https://github.com/ocaml-batteries-team/batteries-included/issues/1122#issuecomment-1782348627, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFUFAGVICEAFBH3TNSNPKDYBNFM5AVCNFSM6AAAAAA6RBSTSCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOBSGM2DQNRSG4 . You are receiving this because you commented.Message ID: @.*** com>