From cb54ca6402db79e19de05c69707dd4858b28ef35 Mon Sep 17 00:00:00 2001 From: Joe Groff Date: Thu, 20 Aug 2009 18:36:34 -0500 Subject: [PATCH] clarify 'deprecated' docs --- core/syntax/syntax-docs.factor | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/syntax/syntax-docs.factor b/core/syntax/syntax-docs.factor index a988e57365..cc4b080491 100644 --- a/core/syntax/syntax-docs.factor +++ b/core/syntax/syntax-docs.factor @@ -193,7 +193,8 @@ HELP: delimiter HELP: deprecated { $syntax ": foo ... ; deprecated" } -{ $description "Declares the most recently defined word as deprecated. If the " { $vocab-link "tools.deprecation" } " vocabulary is loaded, usages of deprecated words will be noted as they are made." } ; +{ $description "Declares the most recently defined word as deprecated. If the " { $vocab-link "tools.deprecation" } " vocabulary is loaded, usages of deprecated words will be noted by the " { $link "tools.errors" } " system." } +{ $notes "Code that uses deprecated words continues to function normally; the errors are purely informational. However, code that uses deprecated words should be updated, for the deprecated words are intended to be removed soon." } ; HELP: SYNTAX: { $syntax "SYNTAX: foo ... ;" }