diff options
author | John Whitington <john@coherentgraphics.co.uk> | 2020-07-08 14:13:08 +0100 |
---|---|---|
committer | John Whitington <john@coherentgraphics.co.uk> | 2020-07-08 14:13:08 +0100 |
commit | 0f2954b263dd04c369ceb356829ae7562968a90b (patch) | |
tree | b2c87aba60e75cc30e211d7028bab9a03ee01cbe | |
parent | f410787b8173f7b069837a78eca6b13ed85fc41d (diff) | |
download | ocaml-0f2954b263dd04c369ceb356829ae7562968a90b.tar.gz |
Fixes per travis check-typo and travis changes
-rw-r--r-- | Changes | 3 | ||||
-rw-r--r-- | stdlib/array.mli | 11 | ||||
-rw-r--r-- | stdlib/arrayLabels.mli | 3 | ||||
-rw-r--r-- | stdlib/bytes.mli | 8 | ||||
-rw-r--r-- | stdlib/list.mli | 8 | ||||
-rw-r--r-- | stdlib/string.mli | 14 | ||||
-rw-r--r-- | stdlib/stringLabels.mli | 6 | ||||
-rwxr-xr-x | tools/unlabel | 17 |
8 files changed, 54 insertions, 16 deletions
@@ -153,6 +153,9 @@ Working version - #9468: HACKING.adoc: using dune to get merlin's support (Thomas Refis, review by Gabriel Scherer) +- #9745: Manual: Standard Library labeled and unlabeled documentation unified + (John Whitington, review by Nicolás Ojeda Bär) + ### Compiler user-interface and warnings: * #9011: Do not create .a/.lib files when creating a .cmxa with no modules. diff --git a/stdlib/array.mli b/stdlib/array.mli index 8bf9ab8d6f..d96bd767b3 100644 --- a/stdlib/array.mli +++ b/stdlib/array.mli @@ -13,8 +13,12 @@ (* *) (**************************************************************************) -(* NOTE: When updating arrayLabels.mli, run tools/unlabel to generate - array.mli +(* NOTE: + If this file is arrayLabels.mli, run tools/unlabel after editing it to + generate array.mli. + + If this file is array.mli, do not edit it directly -- edit + arrayLabels.mli instead. *) (** Array operations @@ -280,7 +284,8 @@ val stable_sort : ('a -> 'a -> int) -> 'a array -> unit *) val fast_sort : ('a -> 'a -> int) -> 'a array -> unit -(** Same as {!Array.sort} or {!Array.stable_sort}, whichever is faster on typical input. *) +(** Same as {!Array.sort} or {!Array.stable_sort}, whichever is + faster on typical input. *) (** {1 Iterators} *) diff --git a/stdlib/arrayLabels.mli b/stdlib/arrayLabels.mli index 36cc3f24c7..06a9d03626 100644 --- a/stdlib/arrayLabels.mli +++ b/stdlib/arrayLabels.mli @@ -284,7 +284,8 @@ val stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unit *) val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit -(** Same as {!Array.sort} or {!Array.stable_sort}, whichever is faster on typical input. *) +(** Same as {!Array.sort} or {!Array.stable_sort}, whichever is + faster on typical input. *) (** {1 Iterators} *) diff --git a/stdlib/bytes.mli b/stdlib/bytes.mli index a6de1fbcd2..21dab12ef9 100644 --- a/stdlib/bytes.mli +++ b/stdlib/bytes.mli @@ -13,8 +13,12 @@ (* *) (**************************************************************************) -(* NOTE: When updating bytesLabels.mli, run tools/unlabel to generate - bytes.mli +(* NOTE: + If this file is bytesLabels.mli, run tools/unlabel after editing it to + generate bytes.mli. + + If this file is bytes.mli, do not edit it directly -- edit + bytesLabels.mli instead. *) (** Byte sequence operations. diff --git a/stdlib/list.mli b/stdlib/list.mli index 061158ce11..39a20dd99f 100644 --- a/stdlib/list.mli +++ b/stdlib/list.mli @@ -13,8 +13,12 @@ (* *) (**************************************************************************) -(* NOTE: When updating listLabels.mli, run tools/unlabel to generate - list.mli +(* NOTE: + If this file is listLabels.mli, run tools/unlabel after editing it to + generate list.mli. + + If this file is list.mli, do not edit it directly -- edit + listLabels.mli instead. *) (** List operations. diff --git a/stdlib/string.mli b/stdlib/string.mli index b8fca0d54a..6043e0c703 100644 --- a/stdlib/string.mli +++ b/stdlib/string.mli @@ -13,8 +13,12 @@ (* *) (**************************************************************************) -(* NOTE: When updating stringLabels.mli, run tools/unlabel to generate - string.mli +(* NOTE: + If this file is stringLabels.mli, run tools/unlabel after editing it to + generate string.mli. + + If this file is string.mli, do not edit it directly -- edit + stringLabels.mli instead. *) (** String operations. @@ -307,11 +311,13 @@ val uncapitalize_ascii : string -> string using the US-ASCII character set. @since 4.05.0 in labeled module, 4.03.0 in unlabeled *) -val starts_with : prefix (* comment thwarts tools/unlabel *) :string -> string -> bool +val starts_with : + prefix (* comment thwarts tools/unlabel *) :string -> string -> bool (** [String.starts_with prefix s] tests if [s] starts with [prefix] @since 4.12.0 *) -val ends_with : suffix (* comment thwarts tools/unlabel *) :string -> string -> bool +val ends_with : + suffix (* comment thwarts tools/unlabel *) :string -> string -> bool (** [ends_with suffix s] tests if [s] ends with [suffix] @since 4.12.0 *) diff --git a/stdlib/stringLabels.mli b/stdlib/stringLabels.mli index 61adf4edc7..3892a5a4c0 100644 --- a/stdlib/stringLabels.mli +++ b/stdlib/stringLabels.mli @@ -311,11 +311,13 @@ val uncapitalize_ascii : string -> string using the US-ASCII character set. @since 4.05.0 in labeled module, 4.03.0 in unlabeled *) -val starts_with : prefix (* comment thwarts tools/unlabel *) :string -> string -> bool +val starts_with : + prefix (* comment thwarts tools/unlabel *) :string -> string -> bool (** [String.starts_with prefix s] tests if [s] starts with [prefix] @since 4.12.0 *) -val ends_with : suffix (* comment thwarts tools/unlabel *) :string -> string -> bool +val ends_with : + suffix (* comment thwarts tools/unlabel *) :string -> string -> bool (** [ends_with suffix s] tests if [s] ends with [suffix] @since 4.12.0 *) diff --git a/tools/unlabel b/tools/unlabel index 4dbdb10b81..39886ee8bf 100755 --- a/tools/unlabel +++ b/tools/unlabel @@ -1,4 +1,18 @@ -#!/bin/sh +#! /bin/sh +#************************************************************************** +#* * +#* OCaml * +#* * +#* John Whitington * +#* * +#* Copyright 2020 Institut National de Recherche en Informatique et * +#* en automatique * +#* * +#* All rights reserved. This file is distributed under the terms of * +#* the GNU Lesser General Public License version 2.1, with the * +#* special exception on linking described in the file LICENSE. * +#* * +#************************************************************************** #Removes a label, i.e a space, a variable name, followed by a colon followed by #an alphabetic character or ( or '. This should avoid altering the contents of @@ -8,4 +22,3 @@ perl -p -e "s/ [a-z_]+:([a-z\('])/ \1/g" ../stdlib/listLabels.mli > ../stdlib/li perl -p -e "s/ [a-z_]+:([a-z\('])/ \1/g" ../stdlib/arrayLabels.mli > ../stdlib/array.mli perl -p -e "s/ [a-z_]+:([a-z\('])/ \1/g" ../stdlib/stringLabels.mli > ../stdlib/string.mli perl -p -e "s/ [a-z_]+:([a-z\('])/ \1/g" ../stdlib/bytesLabels.mli > ../stdlib/bytes.mli - |