informalsystems / themis-tracer

A tool for managing complex contexts for developing critical systems
Apache License 2.0
4 stars 0 forks source link

Source code referencing #95

Open shonfeder opened 3 years ago

shonfeder commented 3 years ago

We often need to refer to source code.

We should have a way of referring to it and having parts of the source included in a spec. Many specs end up having a preferred reference implementation with which they are associated. Rather than having to keep things like function signatures manually in sync, we should be able to directly refer to the signatures in the reference implementation.

We might use a syntax that follows the general form of image references for this purpose, e.g.,

%[][file:path/to/file.sh:950::952]

Or we could follow mdBook's approach.