Move synopsis* from definitions to see

diff --git a/basis/see/see-docs.factor b/basis/see/see-docs.factor
index cea2592bc2fffde960e9edbdb9ee3d9308955531..6d51b42a86c11214ae7f29a92e36cddcf7fefbd2 100644 (file)
--- a/basis/see/see-docs.factor
+++ b/basis/see/see-docs.factor
@@ -50,6 +50,9 @@ $nl
 "Printing a definition:"
 { $subsection see }
 "Printing the methods defined on a generic word or class (see " { $link "objects" } "):"
-{ $subsection see-methods } ;
+{ $subsection see-methods }
+"Definition specifiers implementing the " { $link "definition-protocol" } " should also implement the " { $emphasis "see protocol" } ":"
+{ $subsection see* }
+{ $subsection synopsis* } ;
 
 ABOUT: "see"
\ No newline at end of file

diff --git a/basis/see/see.factor b/basis/see/see.factor
index 041a72ea0e7a1999dc0d5c1bb24ac8a5e6407fd4..32f49499dbf5dca6c65515160bdfe4f6af00a544 100644 (file)
--- a/basis/see/see.factor
+++ b/basis/see/see.factor
@@ -10,6 +10,8 @@ prettyprint.sections sequences sets sorting strings summary
 words words.symbol ;
 IN: see
 
+GENERIC: synopsis* ( defspec -- )
+
 GENERIC: see* ( defspec -- )
 
 : see ( defspec -- ) see* nl ;

diff --git a/core/definitions/definitions-docs.factor b/core/definitions/definitions-docs.factor
index 80da7daa31216b79162b4d4546b1270f90e18440..b53ab28cbc7b99e2898bcc44ed45532e3a3bc8c7 100644 (file)
--- a/core/definitions/definitions-docs.factor
+++ b/core/definitions/definitions-docs.factor
@@ -13,9 +13,9 @@ $nl
 "Definitions can answer a sequence of definitions they directly depend on:"
 { $subsection uses }
 "Definitions must implement a few operations used for printing them in source form:"
-{ $subsection synopsis* }
 { $subsection definer }
-{ $subsection definition } ;
+{ $subsection definition }
+{ $see-also "see" } ;
 
 ARTICLE: "definition-crossref" "Definition cross referencing"
 "A common cross-referencing system is used to track definition usages:"

diff --git a/core/generic/generic-docs.factor b/core/generic/generic-docs.factor
index b90bcc8fc1e20d9f2690c1e7489c9d842a507231..06a8fa87a3b36397e99641fcf0538d31009e18cf 100644 (file)
--- a/core/generic/generic-docs.factor
+++ b/core/generic/generic-docs.factor
@@ -62,7 +62,7 @@ ARTICLE: "method-combination" "Custom method combination"
     { { $link POSTPONE: HOOK: } { $link hook-combination } }
     { { $link POSTPONE: MATH: } { $link math-combination } }
 }
-"Developing a custom method combination requires that a parsing word calling " { $link define-generic } " be defined; additionally, it is a good idea to implement the definition protocol words " { $link definer } " and " { $link synopsis* } " on the class of words having this method combination, to properly support developer tools."
+"Developing a custom method combination requires that a parsing word calling " { $link define-generic } " be defined; additionally, it is a good idea to implement the " { $link "definition-protocol" } " on the class of words having this method combination, to properly support developer tools."
 $nl
 "The combination quotation passed to " { $link define-generic } " has stack effect " { $snippet "( word -- quot )" } ". It's job is to call various introspection words, including at least obtaining the set of methods defined on the generic word, then combining these methods in some way to produce a quotation."
 { $see-also "generic-introspection" } ;