aboutsummaryrefslogtreecommitdiffstats
path: root/system/doc
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2015-12-09 15:19:05 +0100
committerHans Bolinder <[email protected]>2015-12-15 08:55:07 +0100
commit5a66cd64bc814b66c88b79a044f1f1512b21df6d (patch)
tree00ebfab7d227a76c700cd4f4a662d39ca73ad8a8 /system/doc
parentce1cffd6f8812fa6216d9d71afaca20e789b7beb (diff)
downloadotp-5a66cd64bc814b66c88b79a044f1f1512b21df6d.tar.gz
otp-5a66cd64bc814b66c88b79a044f1f1512b21df6d.tar.bz2
otp-5a66cd64bc814b66c88b79a044f1f1512b21df6d.zip
doc: Remove 'is_subtype' from Types and Function Specifications
It is harder to remove is_subtype from the parser since the abstract format does not separate is_subtype from the '::' syntax.
Diffstat (limited to 'system/doc')
-rw-r--r--system/doc/reference_manual/typespec.xml13
1 files changed, 2 insertions, 11 deletions
diff --git a/system/doc/reference_manual/typespec.xml b/system/doc/reference_manual/typespec.xml
index 22627058c1..a238e3135a 100644
--- a/system/doc/reference_manual/typespec.xml
+++ b/system/doc/reference_manual/typespec.xml
@@ -495,7 +495,8 @@
</p>
<pre> -spec id(X) -> X when X :: tuple().</pre>
<p>
- Currently, the <c>::</c> constraint (read as <c>is_subtype</c>) is
+ Currently, the <c>::</c> constraint
+ (read as &laquo;is a subtype of&raquo;) is
the only guard constraint that can be used in the <c>'when'</c>
part of a <c>'-spec'</c> attribute.
</p>
@@ -529,16 +530,6 @@
<pre>
-spec foo({X, integer()}) -> X when X :: atom()
; ([Y]) -> Y when Y :: number().</pre>
- <note>
- <p>
- For backwards compatibility the following form is also allowed:
- </p>
- <pre> -spec id(X) -> X when is_subtype(X, tuple()).</pre>
- <p>
- but its use is discouraged. It will be removed in a future
- Erlang/OTP release.
- </p>
- </note>
<p>
Some functions in Erlang are not meant to return;
either because they define servers or because they are used to