saw-remote-api: Out-of-date documentation in "Crucible setup values" section #1091
Labels
documentation
Issues involving documentation
subsystem: saw-remote-api
Issues related to the SAW server and its RPC bindings
Currently, the Crucible setup values section of the SAW remote API documentation lists the following values that the
setup value
tag can be:saved
null value
Cryptol
array value
field lvalue
element lvalue
global initializer
global lvalue
This doesn't quite agree with what's in the current implementation of
saw-remote-api
, however:saw-script/saw-remote-api/src/SAWServer/Data/SetupValue.hs
Lines 22 to 51 in e3a317a
In particular:
named
, instead ofsaved
as in the documentation.null
andarray
, instead ofnull value
andarray value
as in the documentation.field
, instead offield lvalue
as in the documentation.struct
tag that isn't mentioned in the documentation at all.We should sync the documentation with respect to the current state of the implementation.
The text was updated successfully, but these errors were encountered: