From 52410dee2b6b5ae45a1b790ef83cf1bbbcacb983 Mon Sep 17 00:00:00 2001 From: Cat Stevens Date: Sun, 11 Feb 2018 22:48:24 -0500 Subject: [PATCH] final fixups --- .../help/lint/coverage/coverage-tests.factor | 8 ++--- extra/help/lint/coverage/coverage.factor | 34 +++++++++---------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/extra/help/lint/coverage/coverage-tests.factor b/extra/help/lint/coverage/coverage-tests.factor index 1839d6051e..400cd984d9 100644 --- a/extra/help/lint/coverage/coverage-tests.factor +++ b/extra/help/lint/coverage/coverage-tests.factor @@ -1,6 +1,6 @@ -USING: accessors help.lint.coverage help.lint.coverage.private -help.markup help.syntax kernel literals math math.matrices -sequences sorting tools.test vocabs ; +USING: accessors fuel.help.private help.lint.coverage +help.lint.coverage.private help.markup help.syntax kernel +literals math math.matrices sequences sorting tools.test vocabs ; IN: help.lint.coverage.tests { { $values $description $examples } } [ \ keep word-defines-sections ] unit-test { { $values $contract $examples } } [ \ word-defines-sections ] unit-test -{ eye } [ "eye" find-word ] unit-test +{ empty } [ "empty" find-word ] unit-test { V{ "[" { $[ "math" dup lookup-vocab ] } "] " { "zero?" zero? } ": " } diff --git a/extra/help/lint/coverage/coverage.factor b/extra/help/lint/coverage/coverage.factor index 90dbe518ac..ebb9ae53fd 100644 --- a/extra/help/lint/coverage/coverage.factor +++ b/extra/help/lint/coverage/coverage.factor @@ -1,8 +1,9 @@ -USING: accessors arrays assocs classes classes.error combinators -continuations english formatting fry generic help -help.lint.checks help.markup io io.streams.string io.styles -kernel math namespaces parser sequences sequences.deep sets -sorting splitting strings summary vocabs vocabs.parser words ; +USING: accessors arrays classes classes.error combinators +combinators.short-circuit continuations english eval formatting +fry fuel.help.private generic help help.lint help.lint.checks help.markup io +io.streams.string io.styles kernel math namespaces parser +prettyprint sequences sequences.deep sets sorting splitting strings summary +vocabs words words.alias ; FROM: namespaces => set ; IN: help.lint.coverage @@ -88,11 +89,15 @@ M: word-help-coverage summary : should-define ( word -- spec ) { - { [ dup predicate? ] [ drop { } ] } ! predicate?s have generated docs - { [ dup error-class? ] [ drop { $values $description $error-description } ] } - { [ dup class? ] [ drop { $class-description } ] } - { [ dup generic? ] [ drop { $values $contract $examples } ] } - { [ dup word? ] [ drop { $values $description $examples } ] } + ! predicates have generated docs + { [ dup predicate? ] [ drop { } ] } + ! aliases should describe why they exist but ideally $values should be + ! automatically inherited from the aliased word's docs + { [ dup alias? ] [ drop { $values $description } ] } + { [ dup error-class? ] [ drop { $values $description $error-description } ] } + { [ dup class? ] [ drop { $class-description } ] } + { [ dup generic? ] [ drop { $values $contract $examples } ] } + { [ dup word? ] [ drop { $values $description $examples } ] } [ drop no-cond ] } cond ; @@ -106,14 +111,6 @@ M: word-help-coverage summary : missing-sections ( word -- missing ) [ should-define ] [ word-defines-sections ] bi diff ; - -: find-word ( name -- word/f ) - dup words-named dup length { - { 0 [ 2drop f ] } - { 1 [ first nip ] } - [ drop throw-restarts ] - } case ; - PRIVATE> GENERIC: ( word -- coverage ) @@ -153,3 +150,4 @@ M: word-help-coverage help-coverage. : word-help-coverage. ( word-spec -- ) help-coverage. ; : vocab-help-coverage. ( vocab-spec -- ) help-coverage. ; : prefix-help-coverage. ( prefix-spec private? -- ) help-coverage. ; +