diff options
| author | dos-reis <gdr@axiomatics.org> | 2009-01-07 09:37:52 +0000 |
|---|---|---|
| committer | dos-reis <gdr@axiomatics.org> | 2009-01-07 09:37:52 +0000 |
| commit | 1bdcca4e5a17ffeb4542c689a705b11b9c6a35cb (patch) | |
| tree | 73767214528ae55ec9fd46b4c8b460f4908dc18c /src/algebra | |
| parent | a4baedf72d3abfe9f74ee1dade09a454c0ae7c00 (diff) | |
| download | open-axiom-1bdcca4e5a17ffeb4542c689a705b11b9c6a35cb.tar.gz | |
Fix documentation
Diffstat (limited to 'src/algebra')
| -rw-r--r-- | src/algebra/any.spad.pamphlet | 13 | ||||
| -rw-r--r-- | src/algebra/net.spad.pamphlet | 4 |
2 files changed, 9 insertions, 8 deletions
diff --git a/src/algebra/any.spad.pamphlet b/src/algebra/any.spad.pamphlet index b877b958..d4c44f11 100644 --- a/src/algebra/any.spad.pamphlet +++ b/src/algebra/any.spad.pamphlet @@ -53,16 +53,17 @@ import Boolean Maybe(T: CoercibleTo OutputForm): Public == Private where Public == Join(UnionType,RetractableTo T, CoercibleTo OutputForm) with just: T -> % - ++ maybe(x) injects the value `x' into %. + ++ \spad{just x} injects the value `x' into %. _case: (%,[| T |]) -> Boolean - ++ x case T returns true if x is actually a data of type T. + ++ \spad{x case T} returns true if \spad{x} is actually a data of + ++ type \spad{T}. _case: (%,[| nothing |]) -> Boolean - ++ x case nothing evaluates true if the value for x is missing. + ++ \spad{x case nothing} holds if the value for \spad{x} is missing. autoCoerce: % -> T - ++ autoCoerce is a courtesy coercion function used by the compiler - ++ in case it knows that `x' really is a T. + ++ \spad{autoCoerce} is a courtesy coercion function used by the + ++ compiler in case it knows that `x' really is a \spadtype{T}. nothing: % - ++ represents failure. + ++ \spad{nothing} represents failure or absence of value. Private == add nothing == %nothing$Lisp just x == x : % diff --git a/src/algebra/net.spad.pamphlet b/src/algebra/net.spad.pamphlet index 4f2ded2a..21ca3f39 100644 --- a/src/algebra/net.spad.pamphlet +++ b/src/algebra/net.spad.pamphlet @@ -33,7 +33,7 @@ Conduit(): Category == with )abbrev category INBCON InputByteConduit ++ Author: Gabriel Dos Reis ++ Date Created: August 24, 2008 -++ Date Last Modified: December 26, 2008 +++ Date Last Modified: January 06, 2009 ++ Description: ++ This category describes input byte stream conduits. InputByteConduit(): Category == Conduit with @@ -64,7 +64,7 @@ InputByteConduit(): Category == Conduit with )abbrev category OUTBCON OutputByteConduit ++ Author: Gabriel Dos Reis ++ Date Created: August 24, 2008 -++ Date Last Modified: August 24, 2008 +++ Date Last Modified: January 06, 2008 ++ Description: ++ This category describes output byte stream conduits. OutputByteConduit(): Category == Conduit with |