bundles / papyri latest / papyri / examples / example_with_citations
function
papyri.examples:example_with_citations
source: /papyri/examples.py :377
Signature
def example_with_citations ( ) → None Summary
Example with inline citation references.
Extended Summary
The body of this docstring mixes prose with citation references like [CIT2002] and [Nielsen2020] to exercise the parser path for the visit_citation_reference visitor. Multiple refs can sit in one paragraph ([Smith2020], [Jones1999]) and be resolved to the same per-docstring citation list below.
Notes
Citation definitions use the block-level .. [label] text form. They currently render as placeholders until the citation block visitor is fully wired; references nevertheless carry the label so the viewer can anchor #cite-<label> links.
Example citation 2002, authors, title, year.
Nielsen, M. 2020, "Quantum computation and quantum information".
Smith, J. 2020, "A study of citations in documentation".
Jones, K. 1999, "On the nature of footnotes and citations".
Aliases
-
papyri.examples.example_with_citations