* Set details(open=true) on docs while we redesign

This commit is contained in:
Matthew Honnibal 2015-09-30 11:48:15 +10:00
parent 04c92d4f89
commit 73928001ed

View File

@ -1,5 +1,5 @@
mixin declare_class(name, ref) mixin declare_class(name, ref)
details details(open=true)
summary summary
a(name=ref) a(name=ref)
span.declaration span.declaration
@ -8,7 +8,7 @@ mixin declare_class(name, ref)
block block
mixin method(name, parameters, link_name) mixin method(name, parameters, link_name)
details(open=attributes.open) details(open=true)
summary summary
a(name=link_name) a(name=link_name)
span.declaration span.declaration
@ -30,7 +30,7 @@ mixin param(name, type, value)
block block
mixin attribute(name, type, value) mixin attribute(name, type, value)
details(open=attributes.open) details(open=true)
summary summary
span.declaration span.declaration
code= name code= name
@ -49,25 +49,25 @@ mixin returns(type)
| tmp | tmp
mixin init mixin init
details details(open=true)
summary: h4 Constructors summary: h4 Constructors
block block
mixin callable mixin callable
details details(open=true)
summary: h4 Callable summary: h4 Callable
block block
mixin sequence mixin sequence
details details(open=true)
summary: h4 Sequence API summary: h4 Sequence API
block block
mixin maptype mixin maptype
details details(open=true)
summary: h4 Map summary: h4 Map
block block
@ -75,9 +75,9 @@ mixin maptype
mixin summary mixin summary
block block
mixin en_example //mixin en_example
pre.language-python: code // pre.language-python: code
include ../../code/api.example_war_and_peace // include ../../code/api.example_war_and_peace
mixin SeeAlso(name, link_target) mixin SeeAlso(name, link_target)
a(href=link_target) a(href=link_target)
@ -276,7 +276,7 @@ mixin Func(type1, type2)
+Define("len(doc)") +Define("len(doc)")
| The number of tokens in the document. | The number of tokens in the document.
details details(open=true)
summary: h4 Sentence, entity and noun chunk spans summary: h4 Sentence, entity and noun chunk spans
+attribute("sents", types.generator)(open=true) +attribute("sents", types.generator)(open=true)
@ -294,7 +294,7 @@ mixin Func(type1, type2)
pre.language-python: code pre.language-python: code
include ../../code/api.noun_chunk_spans include ../../code/api.noun_chunk_spans
details details(open=true)
summary: h4 Export/Import summary: h4 Export/Import
+method("to_array", "attr_ids")(open=true) +method("to_array", "attr_ids")(open=true)
@ -328,7 +328,7 @@ mixin Func(type1, type2)
+declare_class("Token", "token") +declare_class("Token", "token")
p A Token represents a single word, punctuation or significant whitespace symbol. Integer IDs are provided for all string features. The (unicode) string is provided by an attribute of the same name followed by an underscore, e.g. #[code token.orth] is an integer ID, #[code token.orth_] is the unicode value. The only exception is the Token.string attribute, which is (unicode) string-typed. p A Token represents a single word, punctuation or significant whitespace symbol. Integer IDs are provided for all string features. The (unicode) string is provided by an attribute of the same name followed by an underscore, e.g. #[code token.orth] is an integer ID, #[code token.orth_] is the unicode value. The only exception is the Token.string attribute, which is (unicode) string-typed.
details details(open=true)
summary: h4 String Features summary: h4 String Features
ul ul
@ -337,18 +337,18 @@ mixin Func(type1, type2)
+LexemeStrings() +LexemeStrings()
details details(open=true)
summary: h4 Boolean Flags summary: h4 Boolean Flags
+LexemeBooleans +LexemeBooleans
+method("check_flag", "flag_id")(open=true) +method("check_flag", "flag_id")(open=true)
| Get the value of one of the boolean flags | Get the value of one of the boolean flags
details details(open=true)
summary: h4 Distributional Features summary: h4 Distributional Features
+LexemeDistributional() +LexemeDistributional()
details details(open=true)
summary: h4 Alignment and Output summary: h4 Alignment and Output
ul ul
@ -374,7 +374,7 @@ mixin Func(type1, type2)
+Define("whitespace_") +Define("whitespace_")
| The number of immediate syntactic children following the word in the string. | The number of immediate syntactic children following the word in the string.
details details(open=true)
summary: h4 Navigating the Parse Tree summary: h4 Navigating the Parse Tree
ul ul
@ -396,7 +396,7 @@ mixin Func(type1, type2)
+method("nbor(i=1)")(open=true) +method("nbor(i=1)")(open=true)
| Get the #[em i]th next / previous neighboring token. | Get the #[em i]th next / previous neighboring token.
details details(open=true)
summary: h4 Named Entities summary: h4 Named Entities
ul ul
@ -445,7 +445,7 @@ mixin Func(type1, type2)
+Define("end") +Define("end")
| The end offset of the span, i.e. #[code.language-python span[-1].i + 1] | The end offset of the span, i.e. #[code.language-python span[-1].i + 1]
details details(open=true)
summary: h4 Navigating the Parse Tree summary: h4 Navigating the Parse Tree
+attribute("root")(open=true) +attribute("root")(open=true)
@ -490,7 +490,7 @@ mixin Func(type1, type2)
+Define("for noun_phrase in doc.noun_chunks") +Define("for noun_phrase in doc.noun_chunks")
+Define("span = Span(doc, start, end, label=0)") +Define("span = Span(doc, start, end, label=0)")
details details(open=true)
summary: h4 Strings summary: h4 Strings
ul ul
@ -512,15 +512,15 @@ mixin Func(type1, type2)
p Most Lexeme attributes can be set, with the exception of the primary key, #[code orth]. Assigning to an attribute of the Lexeme object writes to the underlying struct, so all tokens that are backed by that Lexeme will inherit the new value. p Most Lexeme attributes can be set, with the exception of the primary key, #[code orth]. Assigning to an attribute of the Lexeme object writes to the underlying struct, so all tokens that are backed by that Lexeme will inherit the new value.
details details(open=true)
summary: h4 String Features summary: h4 String Features
+LexemeStrings +LexemeStrings
details details(open=true)
summary: h4 Boolean Features summary: h4 Boolean Features
+LexemeBooleans +LexemeBooleans
details details(open=true)
summary: h4 Distributional Features summary: h4 Distributional Features
+LexemeDistributional +LexemeDistributional
@ -557,7 +557,7 @@ mixin Func(type1, type2)
+Define("token.vocab") +Define("token.vocab")
+Define("lexeme.vocab") +Define("lexeme.vocab")
details details(open=true)
summary: h4 Save and Load summary: h4 Save and Load
+method("dump", "loc")(open=true) +method("dump", "loc")(open=true)
@ -617,7 +617,7 @@ mixin Func(type1, type2)
p If you create another instance, it will map strings to different integers – which is usually not what you want. p If you create another instance, it will map strings to different integers – which is usually not what you want.
details details(open=true)
summary: h4 Save and Load summary: h4 Save and Load
+method("dump", "loc")(open=true) +method("dump", "loc")(open=true)