Liking cljdoc? Tell your friends :D

hive-ingestor-rfc.index

The RFC registry: what a document cannot know about itself.

An RFC's masthead carries Obsoletes:/Updates: — edges pointing BACKWARD. Whether the document has since been obsoleted, and what its current status is, exist only in the registry (rfc-index.xml). A parser reading the .txt can build supersession edges but can never mark a document HISTORIC, so retrieval over the corpus answers present-tense questions confidently and wrongly.

This namespace turns the registry into facets the ingest pipeline attaches to both the document and its chunks.

The RFC registry: what a document cannot know about itself.

An RFC's masthead carries Obsoletes:/Updates: — edges pointing BACKWARD.
Whether the document has since been obsoleted, and what its current status
is, exist only in the registry (rfc-index.xml). A parser reading the .txt
can build supersession edges but can never mark a document HISTORIC, so
retrieval over the corpus answers present-tense questions confidently and
wrongly.

This namespace turns the registry into facets the ingest pipeline attaches
to both the document and its chunks.
raw docstring

enrich-metadataclj

(enrich-metadata metadata record)

Document metadata plus the registry's view of this RFC.

:facets is the host's generic seam — it emits them on the document entry and on every chunk of it, so a retrieval hit can be marked superseded without the ingestor ever learning what an RFC is.

Document metadata plus the registry's view of this RFC.

:facets is the host's generic seam — it emits them on the document entry
and on every chunk of it, so a retrieval hit can be marked superseded
without the ingestor ever learning what an RFC is.
sourceraw docstring

entry->recordclj

(entry->record entry)

One <rfc-entry> as {:number :status :obsoleted-by :updated-by :title}.

One <rfc-entry> as {:number :status :obsoleted-by :updated-by :title}.
sourceraw docstring

facetsclj

(facets record)

Registry facets for one RFC: its current status and what supersedes it.

status:historic and obsoleted-by:6265 are the tags that let a hit be marked superseded at read time. Returns [] when the registry says nothing.

Registry facets for one RFC: its current status and what supersedes it.

`status:historic` and `obsoleted-by:6265` are the tags that let a hit be
marked superseded at read time. Returns [] when the registry says nothing.
sourceraw docstring

index-file-nameclj

The registry file inside an rsync mirror of the series.

The registry file inside an rsync mirror of the series.
sourceraw docstring

parseclj

(parse path)

Parse rfc-index.xml at PATH into {rfc-number -> record}.

Returns Result. The registry is one 10 MB file read once per run, not per document.

Parse rfc-index.xml at PATH into {rfc-number -> record}.

Returns Result. The registry is one 10 MB file read once per run, not per
document.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close