{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "No Docstrings" } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "/papyri/examples.py", "item_line": 0, "item_type": "module", "aliases": [ "papyri.examples" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "see_also": [], "signature": null, "references": null, "qa": "papyri.examples", "arbitrary": [ { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This module contains examples, none of the functions, classes or other attribute should have any effects when called. Paragraphs should be able to contain plain " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "links" } ], "url": "https://github.com/jupyter/papyri", "title": "" }, { "__type": "Text", "__tag": 4046, "value": ", or link via directives: " }, { "__type": "CrossRef", "__tag": 4002, "value": "papyri", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri" }, "kind": "module" } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Examples Modules Heading 1" } ], "level": 0, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "link to " }, { "__type": "InlineRole", "__tag": 4003, "value": "numpy.sin", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " , " }, { "__type": "InlineRole", "__tag": 4003, "value": "numpy:sin", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.linspace", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "numpy", "version": "*", "kind": "api", "path": "numpy:linspace" }, "kind": "module" } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Heading 2" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [], "title": [ { "__type": "Text", "__tag": 4046, "value": "Heading 3" } ], "level": 2, "target": null }, { "__type": "Section", "__tag": 4015, "children": [], "title": [ { "__type": "Text", "__tag": 4046, "value": "heading 4" } ], "level": 3, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In my understanding FieldList should in general not happen in the final Documents, they are supposed to be processed by the software reading them, and typically appear at the beginning of directive." } ] }, { "__type": "FieldList", "__tag": 4035, "children": [ { "__type": "FieldListItem", "__tag": 4036, "name": [ { "__type": "Text", "__tag": 4046, "value": "fieldlistitem" } ], "body": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "at least that the name tree sitter rst give it." } ] } ] }, { "__type": "FieldListItem", "__tag": 4036, "name": [ { "__type": "Text", "__tag": 4046, "value": "another" } ], "body": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "is another fieldlistItem in this field list and it's description" } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "FieldList" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Enumeration list." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 1" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 2" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 3" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Unordered list" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 1" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 2" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "item 3" } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Enumeration and unordered lists" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "term 1" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Definition 1." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "term 2" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Definition 2, paragraph 1." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Definition 2, paragraph 2." } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Definition Lists" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An admonition note !" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a link to " }, { "__type": "Link", "__tag": 4049, "children": [ { "__type": "Text", "__tag": 4046, "value": "Jupyter website" } ], "url": "https://jupyter.org", "title": "" } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Admonitions" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from package import module\nmodule.call(\"string\")", "execution_status": null } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Code (title 2)" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Math should both work as standalone formulas that takes a block:" } ] }, { "__type": "Math", "__tag": 4058, "value": "\\pi = 3.14159" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "More complex formula:" } ] }, { "__type": "Math", "__tag": 4058, "value": "\\int_0^\\infty f(\\delta v) \\partial v" }, { "__type": "Math", "__tag": 4058, "value": "\\nabla^2X = \\vec {rot} (\\vec {rot}(X)) = \\vec{grad}(div(X)) - \\Delta X" }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "But should be also available in inline context, for example we know that " }, { "__type": "InlineMath", "__tag": 4057, "value": "\\pi^2 \\simeq 10" }, { "__type": "Text", "__tag": 4046, "value": ", and that " }, { "__type": "InlineMath", "__tag": 4057, "value": "1+1=10" }, { "__type": "Text", "__tag": 4046, "value": " when counting in binary." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Math" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "This should be a verb-\n-batim block", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a Transition:" } ] }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a block quote, to do, we know that Attributions are not supported right now." } ] }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "\"We have weaponed the Tab Key\"" } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Literal Blocks (verbatim)" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This text uses a substitution: " }, { "__type": "Text", "__tag": 4046, "value": "Papyri" }, { "__type": "Text", "__tag": 4046, "value": " is the package name." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Substitutions" } ], "level": 2, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Citation references link inline mentions to a matching bibliographic citation defined elsewhere in the document, typically at the bottom of a docstring. A reference looks like " }, { "__type": "CitationReference", "__tag": 4063, "label": "CIT2002" }, { "__type": "Text", "__tag": 4046, "value": ", and multiple references such as " }, { "__type": "CitationReference", "__tag": 4063, "label": "Smith2020" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CitationReference", "__tag": 4063, "label": "Jones1999" }, { "__type": "Text", "__tag": 4046, "value": " can appear in the same paragraph. Labels follow the RST \"simple reference name\" rule (letters, digits, hyphens)." } ] }, { "__type": "Citation", "__tag": 4064, "label": "CIT2002", "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Example citation 2002, authors, title, year." } ] } ] }, { "__type": "Citation", "__tag": 4064, "label": "Smith2020", "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Smith, J. 2020, \"A study of citations in documentation\"." } ] } ] }, { "__type": "Citation", "__tag": 4064, "label": "Jones1999", "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Jones, K. 1999, \"On the nature of footnotes and citations\"." } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Citation references" } ], "level": 2, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Quotes are not implemented yet in the parser, this section below will appear empty" } ] }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "ThematicBreak", "__tag": 4019 } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Quotes" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Please have a look at the source to see the custom directives. The file " }, { "__type": "InlineCode", "__tag": 4051, "value": "example/papyri.toml" }, { "__type": "Text", "__tag": 4046, "value": " also show how to register a custom callable for a custom directive handler " } ] }, { "__type": "Code", "__tag": 4050, "value": "[global.directives]\nmydirective='papyri.examples:_mydirective_handler'", "execution_status": null }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "Code", "__tag": 4050, "value": ".. directive:: those are the **arguments**, passed as a ``string``\n {\n \"the\": \"\",\n \"flags\": \"\",\n \"and\": \"Here\",\n \"are\": \"some\",\n \"option\": \"field\"\n }\n Beyond this is the core of the directive, it will be stored as a raw string\n in the value of Directive without the leading indentation. It is the\n responsibility of the directive handler to parse the directive and return\n corresponding ast nodes for further processing.", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "those are the " }, { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "arguments" } ] }, { "__type": "Text", "__tag": 4046, "value": ", passed as a " }, { "__type": "InlineCode", "__tag": 4051, "value": "string" } ] }, { "__type": "Code", "__tag": 4050, "value": "_mydirective_handler(\nargs='those are the **arguments**, passed as a ``string``',\noptions={'the': '', 'flags': '', 'and': 'Here', 'are': 'some', 'option': 'field'}, \nvalue='Beyond this is the core of the directive, it will be stored as a raw string\\nin the value of Directive without the leading indentation. It is the\\nresponsibility of the directive handler to parse the directive and return\\ncorresponding ast nodes for further processing.'\n", "execution_status": null }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "Code", "__tag": 4050, "value": ".. directive:: \n {}\n A second directive to play\n with the indentation level with _italic_, **bold**, are not parsed.", "execution_status": null }, { "__type": "Code", "__tag": 4050, "value": "_mydirective_handler(\nargs='',\noptions={}, \nvalue='A second directive to play\\nwith the indentation level with _italic_, **bold**, are not parsed.'\n", "execution_status": null }, { "__type": "ThematicBreak", "__tag": 4019 }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Nested directives:" } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "warning", "base_type": "warning", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "warning " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This warnings " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "should" } ] }, { "__type": "Text", "__tag": 4046, "value": " contain a deprecation:" } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "deprecated", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "deprecated 0.04" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This should be deprecated" } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is just an " }, { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "example" } ] }, { "__type": "Text", "__tag": 4046, "value": " and is not " }, { "__type": "InlineCode", "__tag": 4051, "value": "deprecated" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Directive" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This paragraph should contain a literal with a new line " }, { "__type": "InlineCode", "__tag": 4051, "value": "here->| |<" }, { "__type": "Text", "__tag": 4046, "value": ", in the final output it should render properly without the line break, but a space." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Various test cases" } ], "level": 0, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "In addition to " }, { "__type": "CrossRef", "__tag": 4002, "value": "example1", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:example1" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", this module exposes a small gallery of callables covering the main kinds of Python signatures papyri has to handle:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "simple_generator", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:simple_generator" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "fibonacci", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:fibonacci" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — plain synchronous generators." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "async_fetch", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:async_fetch" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — an " }, { "__type": "InlineCode", "__tag": 4051, "value": "async def" }, { "__type": "Text", "__tag": 4046, "value": " coroutine function." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "async_counter", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:async_counter" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — an " }, { "__type": "InlineCode", "__tag": 4051, "value": "async def" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "generator" } ] }, { "__type": "Text", "__tag": 4046, "value": " (asynchronous iterator)." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "positional_only", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:positional_only" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "keyword_only", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:keyword_only" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "mixed_signature", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:mixed_signature" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — parameter-kind coverage (positional-only, keyword-only, all-kinds)." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "higher_order", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:higher_order" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — a " }, { "__type": "CrossRef", "__tag": 4002, "value": "Callable", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "collections", "version": "*", "kind": "api", "path": "collections.abc:Callable" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " annotation." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "Patti", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "papyri.examples:Patti" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " — a class whose methods cross-link to the functions above." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Their docstrings reference each other with " }, { "__type": "InlineCode", "__tag": 4051, "value": ":func:" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": ":meth:" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": ":class:" }, { "__type": "Text", "__tag": 4046, "value": " roles so the cross-linker has a self-contained, fully resolvable graph to exercise." } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Signature gallery" } ], "level": 1, "target": null }, { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Interpreted text with a trailing alphabetic suffix is technically invalid RST (the spec requires the end-string to be followed by non-alphanumeric characters), but it is common in scientific docstrings. The RST-correct form uses a backslash-escaped space: " }, { "__type": "InlineCode", "__tag": 4051, "value": "\\`None\\`\\ s" }, { "__type": "Text", "__tag": 4046, "value": ". Papyri applies a best-effort heuristic that splits the node into an " }, { "__type": "InlineCode", "__tag": 4051, "value": "InlineRole" }, { "__type": "Text", "__tag": 4046, "value": " plus a plain " }, { "__type": "InlineCode", "__tag": 4051, "value": "Text" }, { "__type": "Text", "__tag": 4046, "value": " suffix." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Examples of the pattern (rendered here so the viewer can exercise the fix):" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Returning `None`s when no data is found." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An array of `ndarray`s stacked along axis 0." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Pass `True`s and `False`s for boolean masks." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Either `int`s or `float`s are accepted." } ] } ] } ] } ], "title": [ { "__type": "Text", "__tag": 4046, "value": "Backtick edge cases" } ], "level": 1, "target": null } ], "local_refs": [] }