From f2440381cd45714eff023332128a3a519400df05 Mon Sep 17 00:00:00 2001 From: Slava Pestov <slava@slava-pestovs-macbook-pro.local> Date: Thu, 3 Apr 2008 21:29:49 -0500 Subject: [PATCH] More documentation updates --- core/classes/mixin/mixin-docs.factor | 6 ++++-- core/classes/tuple/tuple-docs.factor | 2 +- core/classes/union/union-docs.factor | 4 +++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/core/classes/mixin/mixin-docs.factor b/core/classes/mixin/mixin-docs.factor index a685d70571..82dec5cec0 100755 --- a/core/classes/mixin/mixin-docs.factor +++ b/core/classes/mixin/mixin-docs.factor @@ -1,5 +1,5 @@ USING: help.markup help.syntax help words compiler.units -classes ; +classes sequences ; IN: classes.mixin ARTICLE: "mixins" "Mixin classes" @@ -10,7 +10,9 @@ ARTICLE: "mixins" "Mixin classes" { $subsection add-mixin-instance } "The set of mixin classes is a class:" { $subsection mixin-class } -{ $subsection mixin-class? } ; +{ $subsection mixin-class? } +"Mixins are used to defines suites of behavior which are generally useful and can be applied to user-defined classes. For example, the " { $link immutable-sequence } " mixin can be used with user-defined sequences to make them immutable." +{ $see-also "unions" "tuple-subclassing" } ; HELP: mixin-class { $class-description "The class of mixin classes." } ; diff --git a/core/classes/tuple/tuple-docs.factor b/core/classes/tuple/tuple-docs.factor index 9ba51d433f..87e035958b 100755 --- a/core/classes/tuple/tuple-docs.factor +++ b/core/classes/tuple/tuple-docs.factor @@ -140,7 +140,7 @@ $nl } { $subsection "tuple-inheritance-example" } { $subsection "tuple-inheritance-anti-example" } -{ $see-also "call-next-method" "parametrized-constructors" } ; +{ $see-also "call-next-method" "parametrized-constructors" "unions" "mixins" } ; ARTICLE: "tuple-introspection" "Tuple introspection" "In addition to the slot reader and writer words which " { $link POSTPONE: TUPLE: } " defines for every tuple class, it is possible to construct and take apart entire tuples in a generic way." diff --git a/core/classes/union/union-docs.factor b/core/classes/union/union-docs.factor index 237f32c3e0..91726b6697 100755 --- a/core/classes/union/union-docs.factor +++ b/core/classes/union/union-docs.factor @@ -11,7 +11,9 @@ ARTICLE: "unions" "Union classes" { $subsection members } "The set of union classes is a class:" { $subsection union-class } -{ $subsection union-class? } ; +{ $subsection union-class? } +"Unions are used to define behavior shared between a fixed set of classes." +{ $see-also "mixins" "tuple-subclassing" } ; ABOUT: "unions"