[go: up one dir, main page]

Scoru: Missing/unclear documentation

SCORU origination command now takes a parameters_ty argument provided by the user:

  • In the sc_rollup_operations.mli file, the docstring of originate isn't updated with this new argument
(** [originate context ~kind ~boot_sector] adds a new rollup running in a
    given [kind] initialized with a [boot_sector]. *)
val originate :
  context ->
  kind:Sc_rollup.Kind.t ->
  boot_sector:string ->
  parameters_ty:Script_repr.lazy_expr ->
  (origination_result * context) tzresult Lwt.t
  • The docstring in the CLI is not sufficient (at least, for me :-) ) to understand where/how this is used:
      @@ param
           ~name:"parameters_type"
           ~desc:
             "The type of parameters that the smart-contract rollup accepts."
           data_parameter
  • There is no documentation in operation_repr
  | Sc_rollup_originate : {
      kind : Sc_rollups.Kind.t;
      boot_sector : string;
      parameters_ty : Script_repr.lazy_expr;
    }
      -> Kind.sc_rollup_originate manager_operation

(first assignment based on git blame, feel free to re-assign)