Protocol/Docs: Docstring interfaces in lib_protocol
|
---|
Context
In an effort to keep our protocol code (in src/proto_alpha/lib_protocol
) maintainable for future changes, the goal is to add a docstring header in each file of the the protocol.
Contributes to Issue #205 where interfaces to be documented are listed.
NB: Partially overlaps with other MRs adding docstrings in economic protocol modules (see nomadic-labs/tezos#542).
Checklist of files to be docstring-ed
-
alpha_context.mli -
alpha_services.mli -
amendment.mli -
apply.mli -
apply_results.mli -
baking.mli -
blinded_public_key_hash.mli - MR !2984 (merged) ??
-
block_header_repr.mli -
bootstrap_storage.mli -
commitment_repr.mli -
commitment_storage.mli -
constants_repr.mli -
constants_services.mli -
constants_storage.mli -
contract_hash.mli -
contract_repr.mli -
contract_services.mli -
contract_storage.mli -
cycle_repr.mli -
delegate_activation_storage.mli -
delegate_services.mli -
delegate_storage.mli -
fees_storage.mli -
fitness_repr.mli -
fixed_point_repr.mli -
frozen_deposits_storage.mli -
gas_limit_repr.mli -
init_storage.mli -
lazy_storage_diff.mli -
lazy_storage_kind.mli -
level_repr.mli -
level_storage.mli -
main.mli -
manager_repr.mli -
michelson_v1_gas.mli -
michelson_v1_primitives.mli -
misc.mli -
nonce_hash.mli -
nonce_storage.mli -
operation_repr.mli - MR !2984 (merged)
- MR !2628 (merged)
-
parameters_repr.mli -
period_repr.mli -
raw_context.mli -
raw_level_repr.mli -
receipt_repr.mli -
roll_repr_legacy.mli -
roll_storage_legacy.mli -
saturation_repr.mli -
script_expr_hash.mli -
script_interpreter.mli -
script_int_repr.mli -
script_ir_annot.mli -
script_ir_translator.mli -
script_map.mli -
script_set.mli -
script_repr.mli -
script_tc_errors_registration.mli -
script_timestamp_repr.mli -
seed_repr.mli -
seed_storage.mli -
services_registration.mli -
stake_storage.mli -
state_hash.mli -
storage_costs.mli -
storage_description.mli -
storage_functors.mli -
storage.mli -
tez_repr.mli -
time_repr.mli -
vote_repr.mli -
vote_storage.mli -
voting_period_repr.mli -
voting_period_storage.mli -
voting_services.mli
Edited by Hai Nguyen Van