docs.phext.io
LATEST REFERENCE
Reference as of head commit 0f1189dfda9c6526130393f405b6733bc84c8b51 · 3 commits audited · chain sha256 7cf79fec1d1d8b2c…

phccbox — project documentation

Scanned by phdoc 0.1.0 on 2026-11-22 (Exocortical Epoch 95). Project root: /home/wbic16/phdoc-sweep/proj/phccbox/. Scanned at commit 0f1189dfda9c6526130393f405b6733bc84c8b51. Every fact in this document was read from its own records: its manifests, its git log, and its source text. Nothing here was guessed.

This document holds: what the project depends on, who wrote it, how large and how complex it is, the state of its quality signals, the RFCs it declares, where its upstream repo lives, and a plain English note for every public method and command.


Dependencies

No dependency manifest was found (no Cargo.toml, package.json, requirements.txt, or go.mod), so no dependencies are declared in a form the scanner reads.


Authors

The git log holds 3 commits.

The author of record is Will Bickford — 3 commits folded into his account. Will's ruling (2026-11-22): all Exocortical authors fold into his account — "I speak for the cluster." The fold is presentation only: the git history is unchanged, and the per-persona detail is kept as annotation.

Annotation, by persona (all folded into Will Bickford):


Complexity

The measure is stated plainly, and no single score is made: lines are counted per file as total lines, blank lines, comment lines, and code lines (total minus blank minus comment). Functions are counted where the scanner reads them, and the largest functions are given by their span in lines.

All languages: 58 files, 8346 lines total, 7265 lines of code. Functions read: 22.

Largest files:

Largest functions, by span in lines:


Code quality signals

Each signal is named and shown with its evidence. A signal is a fact the scanner read, not a grade.


Declared RFCs

No rfcs.json was found in this project, so it declares no RFCs. This is a finding, not an error: the project has not made an RFC declaration.


Upstream git repo


Public methods and commands

Every public method and command the scanner found, each with a plain English note. A note says where its words came from: the code's own doc comment, the item's signature, the user's agent, or it is marked awaiting a summary.


function — read

Found in exo-src/gen_literals.py at line 10.

Signature: def read(name):

What it does: Function read takes name and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cstr

Found in exo-src/gen_literals.py at line 14.

Signature: def cstr(s):

What it does: Function cstr takes s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — emit

Found in exo-src/gen_literals.py at line 26.

Signature: def emit(name, items):

What it does: items: list of (cname, python-string) -> static const char * arrays

(Where these words came from: doc comment.)


function — heredoc

Found in exo-src/gen_literals.py at line 34.

Signature: def heredoc(text, start_marker, end_marker="EOF"):

What it does: Return the raw text between the line containing start_marker's '<<'

(Where these words came from: doc comment.)


function — tmpl

Found in exo-src/gen_literals.py at line 57.

Signature: def tmpl(s):

What it does: Convert shell ${VAR} / $VAR expansions into %%VAR%% tokens.

(Where these words came from: doc comment.)


function — note

Found in exo-test/proof.py at line 13.

Signature: def note(s): out.append(s); print(s, flush=True)

What it does: Function note takes s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — extract_heredoc

Found in exo-test/proof.py at line 15.

Signature: def extract_heredoc(script, needle):

What it does: Find the heredoc whose command line contains needle;

(Where these words came from: doc comment.)


function — render_bash

Found in exo-test/proof.py at line 32.

Signature: def render_bash(body, env, quoted):

What it does: Render the body the way bash would inside the original heredoc.

(Where these words came from: doc comment.)


function — read_c_template

Found in exo-test/proof.py at line 40.

Signature: def read_c_template(header, varname):

What it does: Function read_c_template takes header, varname and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — expand

Found in exo-test/proof.py at line 47.

Signature: def expand(tmpl, vals):

What it does: Function expand takes tmpl, vals and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmp

Found in exo-test/proof.py at line 52.

Signature: def cmp(name, a, b):

What it does: Function cmp takes name, a, b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — port_file

Found in exo-test/proof.py at line 61.

Signature: def port_file(case, rel):

What it does: Function port_file takes case, rel and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — append_check

Found in exo-test/proof.py at line 98.

Signature: def append_check(name, script, needle, env, case, rel, seed):

What it does: Function append_check takes name, script, needle, env, case, rel, seed and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — note

Found in exo-test/ship/proof.py at line 13.

Signature: def note(s): out.append(s); print(s, flush=True)

What it does: Function note takes s and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — extract_heredoc

Found in exo-test/ship/proof.py at line 15.

Signature: def extract_heredoc(script, needle):

What it does: Find the heredoc whose command line contains needle;

(Where these words came from: doc comment.)


function — render_bash

Found in exo-test/ship/proof.py at line 32.

Signature: def render_bash(body, env, quoted):

What it does: Render the body the way bash would inside the original heredoc.

(Where these words came from: doc comment.)


function — read_c_template

Found in exo-test/ship/proof.py at line 40.

Signature: def read_c_template(header, varname):

What it does: Function read_c_template takes header, varname and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — expand

Found in exo-test/ship/proof.py at line 47.

Signature: def expand(tmpl, vals):

What it does: Function expand takes tmpl, vals and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — cmp

Found in exo-test/ship/proof.py at line 52.

Signature: def cmp(name, a, b):

What it does: Function cmp takes name, a, b and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — port_file

Found in exo-test/ship/proof.py at line 61.

Signature: def port_file(case, rel):

What it does: Function port_file takes case, rel and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — append_check

Found in exo-test/ship/proof.py at line 98.

Signature: def append_check(name, script, needle, env, case, rel, seed):

What it does: Function append_check takes name, script, needle, env, case, rel, seed and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


function — put

Found in scripts/classify.py at line 100.

Signature: def put(name, cls, src):

What it does: Function put takes name, cls, src and gives back nothing; it does its work on what it is given.

(Where these words came from: signature.)


Provenance

This documentation is produced for the export repo wbic16/phdoc (its chain of record lives at docs/phccbox/chain.phext) and for the doc site https://docs.phext.io. Both targets are the project's own configuration, held in its .phdoc.json as "export-repo" and "doc-site"; when a project does not name them, the defaults are wbic16/phdoc and https://docs.phext.io.

Historical reference · chain.phext · latest.md