]> gitweb.factorcode.org Git - factor.git/commitdiff
Help lint and meta-data fixes
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Sun, 8 Mar 2009 07:49:06 +0000 (01:49 -0600)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Sun, 8 Mar 2009 07:49:06 +0000 (01:49 -0600)
basis/colors/constants/constants-docs.factor
basis/colors/constants/constants.factor
basis/core-foundation/attributed-strings/tags.txt [new file with mode: 0644]
basis/delegate/delegate-docs.factor
basis/io/encodings/euc-kr/euc-kr-docs.factor
basis/io/encodings/johab/johab-docs.factor
basis/models/models-docs.factor
basis/windows/com/com-docs.factor

index 633bd20ed24b74299d408a73f3542ce904cbdd95..49d6fce3a15f0fc5c6de0977db3f7ecfed935f61 100644 (file)
@@ -2,7 +2,7 @@ IN: colors.constants
 USING: help.markup help.syntax strings colors ;
 
 HELP: named-color
-{ $values { "string" string } { "color" color } }
+{ $values { "name" string } { "color" color } }
 { $description "Outputs a named color from the " { $snippet "rgb.txt" } " database." }
 { $notes "In most cases, " { $link POSTPONE: COLOR: } " should be used instead." }
 { $errors "Throws an error if the color is not listed in " { $snippet "rgb.txt" } "." } ;
index 0e5610a1441e4ab6f065ff27cf408e942fa2dade..91621c110b4bcdd663ac0404117edaab5e930478 100644 (file)
@@ -27,7 +27,7 @@ PRIVATE>
 
 ERROR: no-such-color name ;
 
-: named-color ( name -- rgb )
+: named-color ( name -- color )
     dup rgb.txt at [ ] [ no-such-color ] ?if ;
 
 : COLOR: scan named-color parsed ; parsing
\ No newline at end of file
diff --git a/basis/core-foundation/attributed-strings/tags.txt b/basis/core-foundation/attributed-strings/tags.txt
new file mode 100644 (file)
index 0000000..2320bdd
--- /dev/null
@@ -0,0 +1,2 @@
+unportable
+bindings
index 9456941880816ce128f430904cd973c10e4a9b0e..42b727852e3491162fdc84ec29594f0eb28613a9 100644 (file)
@@ -13,8 +13,8 @@ HELP: PROTOCOL:
 { define-protocol POSTPONE: PROTOCOL: } related-words
 
 HELP: define-consult
-{ $values { "class" "a class" } { "group" "a protocol, generic word or tuple class" } { "quot" "a quotation" } }
-{ $description "Defines a class to consult, using the given quotation, on the generic words contained in the group." }
+{ $values { "consultation" consultation } }
+{ $description "Defines a class to consult, using the quotation, on the generic words contained in the group." }
 { $notes "Usually, " { $link POSTPONE: CONSULT: } " should be used instead. This is only for runtime use." } ;
 
 HELP: CONSULT:
index 5e109f35366b112e8446d04038ac644d6daa5c67..60cd41ac57a2ad3a55cfa310d23ed89e761da1bf 100644 (file)
@@ -3,8 +3,11 @@
 USING: help.syntax help.markup ;
 IN: io.encodings.euc-kr
 
-ABOUT: euc-kr
-
 HELP: euc-kr
-{ $class-description "This encoding class implements Microsoft's code page #949 encoding, also called Unified Hangul Code or ks_c_5601-1987, UHC. CP949 is extended version of EUC-KR and downward-compatibility to EUC-KR, in practice." }
+{ $class-description "This encoding class implements Microsoft's CP949 encoding, also called Unified Hangul Code or ks_c_5601-1987, UHC. CP949 is extended version of EUC-KR and downward-compatible with EUC-KR in practice." }
 { $see-also "encodings-introduction" } ;
+
+ARTICLE: "io.encodings.euc-kr" "EUC-KR encoding"
+{ $subsection euc-kr } ;
+
+ABOUT: "io.encodings.euc-kr"
\ No newline at end of file
index 1d707e0f7d60c60f138a89a45202b78234fed735..d2eac30b2543b08cc4a4e74e180e3f9f4fb3f3eb 100644 (file)
@@ -3,7 +3,10 @@
 USING: help.syntax help.markup ;
 IN: io.encodings.johab
 
-ABOUT: johab
-
 HELP: johab
 { $class-description "Korean Johab encoding (KSC5601-1992). This encoding is not commonly used anymore." } ;
+
+ARTICLE: "io.encodings.johab" "Korean Johab encoding"
+{ $subsection johab } ;
+
+ABOUT: "io.encodings.johab"
\ No newline at end of file
index 4db71c459567b92a63364dcde8ef7cc8b49efaf0..82dd0354677873760a09f1ac721e23409c3db65f 100644 (file)
@@ -137,7 +137,7 @@ $nl
 { $subsection "models-delay" } ;
 
 ARTICLE: "models-impl" "Implementing models"
-"New types of models can be defined, for example see " { $vocab-link "models.filter" } "."
+"New types of models can be defined, for example see " { $vocab-link "models.arrow" } "."
 $nl
 "Models can execute hooks when activated:"
 { $subsection model-activated }
index 8c7584828fc382980d0a01562ef506380bd37d8f..3a7b7272d748e5d45f53be6fe1afeedc4ce4e4ff 100644 (file)
@@ -15,11 +15,11 @@ HELP: com-release
 { $description "A small wrapper around " { $link IUnknown::Release } ". Decrements the reference count on " { $snippet "interface" } ", releasing the underlying object if the reference count has reached zero." } ;\r
 \r
 HELP: &com-release\r
-{ $values { "interface" "Pointer to a COM interface implementing " { $snippet "IUnknown" } } }\r
+{ $values { "alien" "pointer to a COM interface implementing " { $snippet "IUnknown" } } }\r
 { $description "Marks the given COM interface for unconditional release via " { $link com-release } " at the end of the enclosing " { $link with-destructors } " scope." } ;\r
 \r
 HELP: |com-release\r
-{ $values { "interface" "Pointer to a COM interface implementing " { $snippet "IUnknown" } } }\r
+{ $values { "alien" "pointer to a COM interface implementing " { $snippet "IUnknown" } } }\r
 { $description "Marks the given COM interface for release via " { $link com-release } " in the event of an error at the end of the enclosing " { $link with-destructors } " scope." } ;\r
 \r
 { com-release &com-release |com-release } related-words\r