[go: up one dir, main page]

Many mli files lacking comments

A good rough approximation is obtained by listing all .mli files not containing any docstring:

comm -23 <(ls src/**/*.mli | grep -v '/proto_0') <(grep -l '(\*\* ' src/**/*.mli) | sed 's/^/- [ ] /'

A more accurate approximation is obtained by filtering out essentially empty files (containing very few lines, ignoring plain comments):

comm -23 <(ls src/**/*.mli | grep -v '/proto_0' | while read f; do l=$(grep -v '^ *(\*.*\*) *$' $f | wc -l); if test $l -gt 4; then echo $f; fi ; done) <(grep -l '(\*\* ' src/**/*.mli) | sed 's/^/- [ ] /'

which, as of writing, gives

  • src/bin_dal_node/worker_parameters.mli
  • src/bin_node/node_identity_command.mli
  • src/bin_node/node_reconstruct_command.mli
  • src/bin_node/node_replay_command.mli
  • src/bin_node/node_run_command.mli
  • src/bin_node/node_snapshot_command.mli
  • src/bin_node/node_storage_command.mli
  • src/bin_node/node_upgrade_command.mli
  • src/bin_signer/http_daemon.mli
  • src/bin_signer/socket_daemon.mli
  • src/bin_wasm_debugger/plugin/encodings.mli
  • src/lib_base/operation.mli
  • src/lib_base/p2p_addr.mli
  • src/lib_base/p2p_rejection.mli
  • src/lib_base/test_chain_status.mli
  • src/lib_base/test_helpers/tzcheck.mli
  • src/lib_base/unix/logs_simple_config.mli
  • src/lib_base/unix/protocol_files.mli
  • src/lib_benchmark/builtin_models.mli
  • src/lib_benchmark/free_variable.mli
  • src/lib_benchmark/ocamlformat.mli
  • src/lib_benchmark/pyinference.mli
  • src/lib_benchmark/structure_samplers.mli
  • src/lib_bls12_381_polynomial/octez_bls12_381_polynomial.mli
  • src/lib_client_base_unix/client_context_unix.mli
  • src/lib_client_base_unix/client_main_run.mli
  • src/lib_client_commands/client_commands.mli
  • src/lib_crypto/aggregate_signature.mli
  • src/lib_crypto/block_hash.mli
  • src/lib_crypto/block_metadata_hash.mli
  • src/lib_crypto/hacl.mli
  • src/lib_crypto/operation_hash.mli
  • src/lib_crypto/protocol_hash.mli
  • src/lib_error_monad/TzMonad.mli
  • src/lib_error_monad/core_maker.mli
  • src/lib_error_monad/error_classification.mli
  • src/lib_error_monad_legacy/error_monad.mli
  • src/lib_gossipsub/gossipsub_automaton.mli
  • src/lib_gossipsub/gossipsub_worker.mli
  • src/lib_gossipsub/message_cache.mli
  • src/lib_gossipsub/peers_score.mli
  • src/lib_gossipsub/tezos_gossipsub.mli
  • src/lib_hacl/gen/api_json.mli
  • src/lib_injector/injector_functor.mli
  • src/lib_injector/injector_worker_types.mli
  • src/lib_kzg/kate_amortized.mli
  • src/lib_layer2_store/irmin_store.mli
  • src/lib_layer2_store/smart_rollup_context_hash.mli
  • src/lib_lwt_result_stdlib/bare/structs/monad.mli
  • src/lib_lwt_result_stdlib/bare/structs/seq_es.mli
  • src/lib_lwt_result_stdlib/traced/structs/hashtbl.mli
  • src/lib_lwt_result_stdlib/traced/structs/map.mli
  • src/lib_lwt_result_stdlib/traced/structs/seq_es.mli
  • src/lib_lwt_result_stdlib/traced/structs/seq_s.mli
  • src/lib_lwt_result_stdlib/traced/structs/set.mli
  • src/lib_mec/bandersnatch.mli
  • src/lib_mec/bls12_381_ref.mli
  • src/lib_mec/bn254.mli
  • src/lib_mec/curve25519.mli
  • src/lib_mec/iterator.mli
  • src/lib_mec/jubjub.mli
  • src/lib_mec/neptunus.mli
  • src/lib_mec/orchard.mli
  • src/lib_mec/pallas.mli
  • src/lib_mec/pedersen_hash.mli
  • src/lib_mec/poseidon128.mli
  • src/lib_mec/poseidon252.mli
  • src/lib_mec/reddsa.mli
  • src/lib_mec/redjubjub.mli
  • src/lib_mec/secp256k1.mli
  • src/lib_mec/secp256r1.mli
  • src/lib_mec/tweedledee.mli
  • src/lib_mec/tweedledum.mli
  • src/lib_mec/vesta.mli
  • src/lib_micheline/micheline_printer.mli
  • src/lib_mockup/mockup_commands.mli
  • src/lib_node_config/config_command.mli
  • src/lib_octogram/agent_state.mli
  • src/lib_octogram/prometheus_server.mli
  • src/lib_octogram/recipe.mli
  • src/lib_octogram/remote_prometheus.mli
  • src/lib_octogram/template.mli
  • src/lib_octogram/uri.mli
  • src/lib_p2p/p2p_disconnection_reason.mli
  • src/lib_p2p_services/p2p_errors.mli
  • src/lib_plompiler/range_checks.mli
  • src/lib_protocol_compiler/registerer/tezos_protocol_registerer.mli
  • src/lib_protocol_environment/environment_V0.mli
  • src/lib_protocol_environment/environment_V1.mli
  • src/lib_protocol_environment/sigs/v0/RPC_arg.mli
  • src/lib_protocol_environment/sigs/v0/RPC_context.mli
  • src/lib_protocol_environment/sigs/v0/RPC_path.mli
  • src/lib_protocol_environment/sigs/v0/RPC_query.mli
  • src/lib_protocol_environment/sigs/v0/base58.mli
  • src/lib_protocol_environment/sigs/v0/compare.mli
  • src/lib_protocol_environment/sigs/v0/logging.mli
  • src/lib_protocol_environment/sigs/v0/micheline.mli
  • src/lib_protocol_environment/sigs/v0/option.mli
  • src/lib_protocol_environment/sigs/v0/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v0/signature.mli
  • src/lib_protocol_environment/sigs/v0/time.mli
  • src/lib_protocol_environment/sigs/v1/RPC_arg.mli
  • src/lib_protocol_environment/sigs/v1/RPC_context.mli
  • src/lib_protocol_environment/sigs/v1/RPC_path.mli
  • src/lib_protocol_environment/sigs/v1/RPC_query.mli
  • src/lib_protocol_environment/sigs/v1/base58.mli
  • src/lib_protocol_environment/sigs/v1/bls12_381.mli
  • src/lib_protocol_environment/sigs/v1/compare.mli
  • src/lib_protocol_environment/sigs/v1/logging.mli
  • src/lib_protocol_environment/sigs/v1/micheline.mli
  • src/lib_protocol_environment/sigs/v1/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v1/sapling.mli
  • src/lib_protocol_environment/sigs/v1/signature.mli
  • src/lib_protocol_environment/sigs/v1/time.mli
  • src/lib_protocol_environment/sigs/v1/tzEndian.mli
  • src/lib_protocol_environment/sigs/v10/RPC_context.mli
  • src/lib_protocol_environment/sigs/v10/RPC_path.mli
  • src/lib_protocol_environment/sigs/v10/RPC_query.mli
  • src/lib_protocol_environment/sigs/v10/context_binary.mli
  • src/lib_protocol_environment/sigs/v10/micheline.mli
  • src/lib_protocol_environment/sigs/v10/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v10/sapling.mli
  • src/lib_protocol_environment/sigs/v10/set.mli
  • src/lib_protocol_environment/sigs/v10/signature.mli
  • src/lib_protocol_environment/sigs/v10/time.mli
  • src/lib_protocol_environment/sigs/v10/tzEndian.mli
  • src/lib_protocol_environment/sigs/v10/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v11/RPC_context.mli
  • src/lib_protocol_environment/sigs/v11/RPC_path.mli
  • src/lib_protocol_environment/sigs/v11/RPC_query.mli
  • src/lib_protocol_environment/sigs/v11/context_binary.mli
  • src/lib_protocol_environment/sigs/v11/micheline.mli
  • src/lib_protocol_environment/sigs/v11/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v11/sapling.mli
  • src/lib_protocol_environment/sigs/v11/set.mli
  • src/lib_protocol_environment/sigs/v11/signature.mli
  • src/lib_protocol_environment/sigs/v11/time.mli
  • src/lib_protocol_environment/sigs/v11/tzEndian.mli
  • src/lib_protocol_environment/sigs/v11/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v12/RPC_context.mli
  • src/lib_protocol_environment/sigs/v12/RPC_path.mli
  • src/lib_protocol_environment/sigs/v12/RPC_query.mli
  • src/lib_protocol_environment/sigs/v12/context_binary.mli
  • src/lib_protocol_environment/sigs/v12/micheline.mli
  • src/lib_protocol_environment/sigs/v12/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v12/sapling.mli
  • src/lib_protocol_environment/sigs/v12/set.mli
  • src/lib_protocol_environment/sigs/v12/signature.mli
  • src/lib_protocol_environment/sigs/v12/time.mli
  • src/lib_protocol_environment/sigs/v12/tzEndian.mli
  • src/lib_protocol_environment/sigs/v12/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v13/RPC_context.mli
  • src/lib_protocol_environment/sigs/v13/RPC_path.mli
  • src/lib_protocol_environment/sigs/v13/RPC_query.mli
  • src/lib_protocol_environment/sigs/v13/context_binary.mli
  • src/lib_protocol_environment/sigs/v13/micheline.mli
  • src/lib_protocol_environment/sigs/v13/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v13/sapling.mli
  • src/lib_protocol_environment/sigs/v13/set.mli
  • src/lib_protocol_environment/sigs/v13/signature.mli
  • src/lib_protocol_environment/sigs/v13/time.mli
  • src/lib_protocol_environment/sigs/v13/tzEndian.mli
  • src/lib_protocol_environment/sigs/v13/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v2/RPC_arg.mli
  • src/lib_protocol_environment/sigs/v2/RPC_context.mli
  • src/lib_protocol_environment/sigs/v2/RPC_path.mli
  • src/lib_protocol_environment/sigs/v2/RPC_query.mli
  • src/lib_protocol_environment/sigs/v2/base58.mli
  • src/lib_protocol_environment/sigs/v2/bls12_381.mli
  • src/lib_protocol_environment/sigs/v2/compare.mli
  • src/lib_protocol_environment/sigs/v2/logging.mli
  • src/lib_protocol_environment/sigs/v2/micheline.mli
  • src/lib_protocol_environment/sigs/v2/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v2/sapling.mli
  • src/lib_protocol_environment/sigs/v2/signature.mli
  • src/lib_protocol_environment/sigs/v2/time.mli
  • src/lib_protocol_environment/sigs/v2/tzEndian.mli
  • src/lib_protocol_environment/sigs/v3/RPC_arg.mli
  • src/lib_protocol_environment/sigs/v3/RPC_context.mli
  • src/lib_protocol_environment/sigs/v3/RPC_path.mli
  • src/lib_protocol_environment/sigs/v3/RPC_query.mli
  • src/lib_protocol_environment/sigs/v3/base58.mli
  • src/lib_protocol_environment/sigs/v3/bls12_381.mli
  • src/lib_protocol_environment/sigs/v3/compare.mli
  • src/lib_protocol_environment/sigs/v3/micheline.mli
  • src/lib_protocol_environment/sigs/v3/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v3/sapling.mli
  • src/lib_protocol_environment/sigs/v3/set.mli
  • src/lib_protocol_environment/sigs/v3/signature.mli
  • src/lib_protocol_environment/sigs/v3/time.mli
  • src/lib_protocol_environment/sigs/v3/tzEndian.mli
  • src/lib_protocol_environment/sigs/v4/RPC_context.mli
  • src/lib_protocol_environment/sigs/v4/RPC_path.mli
  • src/lib_protocol_environment/sigs/v4/RPC_query.mli
  • src/lib_protocol_environment/sigs/v4/base58.mli
  • src/lib_protocol_environment/sigs/v4/bls12_381.mli
  • src/lib_protocol_environment/sigs/v4/compare.mli
  • src/lib_protocol_environment/sigs/v4/micheline.mli
  • src/lib_protocol_environment/sigs/v4/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v4/sapling.mli
  • src/lib_protocol_environment/sigs/v4/set.mli
  • src/lib_protocol_environment/sigs/v4/signature.mli
  • src/lib_protocol_environment/sigs/v4/time.mli
  • src/lib_protocol_environment/sigs/v4/tzEndian.mli
  • src/lib_protocol_environment/sigs/v5/RPC_context.mli
  • src/lib_protocol_environment/sigs/v5/RPC_path.mli
  • src/lib_protocol_environment/sigs/v5/RPC_query.mli
  • src/lib_protocol_environment/sigs/v5/bls12_381.mli
  • src/lib_protocol_environment/sigs/v5/micheline.mli
  • src/lib_protocol_environment/sigs/v5/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v5/sapling.mli
  • src/lib_protocol_environment/sigs/v5/set.mli
  • src/lib_protocol_environment/sigs/v5/signature.mli
  • src/lib_protocol_environment/sigs/v5/time.mli
  • src/lib_protocol_environment/sigs/v5/tzEndian.mli
  • src/lib_protocol_environment/sigs/v6/RPC_context.mli
  • src/lib_protocol_environment/sigs/v6/RPC_path.mli
  • src/lib_protocol_environment/sigs/v6/RPC_query.mli
  • src/lib_protocol_environment/sigs/v6/bls12_381.mli
  • src/lib_protocol_environment/sigs/v6/micheline.mli
  • src/lib_protocol_environment/sigs/v6/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v6/sapling.mli
  • src/lib_protocol_environment/sigs/v6/set.mli
  • src/lib_protocol_environment/sigs/v6/signature.mli
  • src/lib_protocol_environment/sigs/v6/time.mli
  • src/lib_protocol_environment/sigs/v6/tzEndian.mli
  • src/lib_protocol_environment/sigs/v6/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v7/RPC_context.mli
  • src/lib_protocol_environment/sigs/v7/RPC_path.mli
  • src/lib_protocol_environment/sigs/v7/RPC_query.mli
  • src/lib_protocol_environment/sigs/v7/micheline.mli
  • src/lib_protocol_environment/sigs/v7/plonk.mli
  • src/lib_protocol_environment/sigs/v7/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v7/sapling.mli
  • src/lib_protocol_environment/sigs/v7/set.mli
  • src/lib_protocol_environment/sigs/v7/signature.mli
  • src/lib_protocol_environment/sigs/v7/time.mli
  • src/lib_protocol_environment/sigs/v7/tzEndian.mli
  • src/lib_protocol_environment/sigs/v7/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v8/RPC_context.mli
  • src/lib_protocol_environment/sigs/v8/RPC_path.mli
  • src/lib_protocol_environment/sigs/v8/RPC_query.mli
  • src/lib_protocol_environment/sigs/v8/micheline.mli
  • src/lib_protocol_environment/sigs/v8/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v8/sapling.mli
  • src/lib_protocol_environment/sigs/v8/set.mli
  • src/lib_protocol_environment/sigs/v8/signature.mli
  • src/lib_protocol_environment/sigs/v8/time.mli
  • src/lib_protocol_environment/sigs/v8/tzEndian.mli
  • src/lib_protocol_environment/sigs/v8/wasm_2_0_0.mli
  • src/lib_protocol_environment/sigs/v9/RPC_context.mli
  • src/lib_protocol_environment/sigs/v9/RPC_path.mli
  • src/lib_protocol_environment/sigs/v9/RPC_query.mli
  • src/lib_protocol_environment/sigs/v9/micheline.mli
  • src/lib_protocol_environment/sigs/v9/raw_hashes.mli
  • src/lib_protocol_environment/sigs/v9/sapling.mli
  • src/lib_protocol_environment/sigs/v9/set.mli
  • src/lib_protocol_environment/sigs/v9/signature.mli
  • src/lib_protocol_environment/sigs/v9/time.mli
  • src/lib_protocol_environment/sigs/v9/tzEndian.mli
  • src/lib_protocol_environment/sigs/v9/wasm_2_0_0.mli
  • src/lib_protocol_updater/updater.mli
  • src/lib_proxy/light_logger.mli
  • src/lib_proxy/logger.mli
  • src/lib_riscv/pvm/backend.mli
  • src/lib_riscv/pvm/storage.mli
  • src/lib_rpc/RPC_description.mli
  • src/lib_rpc/RPC_encoding.mli
  • src/lib_rpc/RPC_error.mli
  • src/lib_rpc/RPC_service.mli
  • src/lib_rpc_http/RPC_client.mli
  • src/lib_rpc_http/RPC_client_errors.mli
  • src/lib_rpc_http/media_type.mli
  • src/lib_sapling/forge.mli
  • src/lib_scoru_wasm/interpreter_encodings.mli
  • src/lib_scoru_wasm/test/helpers/trie.mli
  • src/lib_scoru_wasm/wasm_encoding.mli
  • src/lib_scoru_wasm/wasm_pvm.mli
  • src/lib_shell/chain_directory.mli
  • src/lib_shell/monitor_directory.mli
  • src/lib_shell/peer_validator.mli
  • src/lib_shell/protocol_validator.mli
  • src/lib_shell_benchmarks/benchmarks_shell.mli
  • src/lib_shell_benchmarks/io_benchmarks.mli
  • src/lib_shell_services/block_validator_errors.mli
  • src/lib_shell_services/block_validator_worker_state.mli
  • src/lib_shell_services/chain_services.mli
  • src/lib_shell_services/chain_validator_worker_state.mli
  • src/lib_shell_services/config_services.mli
  • src/lib_shell_services/health_services.mli
  • src/lib_shell_services/peer_validator_worker_state.mli
  • src/lib_shell_services/protocol_services.mli
  • src/lib_shell_services/shell_services.mli
  • src/lib_shell_services/stat_services.mli
  • src/lib_shell_services/validation_errors.mli
  • src/lib_shell_services/version_services.mli
  • src/lib_shell_services/worker_services.mli
  • src/lib_signer_backends/http.mli
  • src/lib_signer_backends/http_gen.mli
  • src/lib_signer_backends/https.mli
  • src/lib_signer_backends/unencrypted.mli
  • src/lib_signer_backends/unix/remote.mli
  • src/lib_signer_backends/unix/socket.mli
  • src/lib_signer_services/signer_messages.mli
  • src/lib_signer_services/signer_services.mli
  • src/lib_smart_rollup/error.mli
  • src/lib_smart_rollup/game.mli
  • src/lib_stdlib/memory.mli
  • src/lib_stdlib/tzEndian.mli
  • src/lib_stdlib_unix/lwt_unix_socket.mli
  • src/lib_validation/patch_context.mli
  • src/lib_version/value/generated_git_info.mli
  • src/lib_webassembly/bin/script/run.mli
  • src/lib_webassembly/bin/script/sexpr.mli
  • src/lib_webassembly/bin/text/arrange.mli
  • src/lib_webassembly/bin/text/print.mli
  • src/lib_webassembly/binary/encode.mli
  • src/lib_webassembly/exec/eval_num.mli
  • src/lib_webassembly/exec/eval_vec.mli
  • src/lib_webassembly/exec/f32_convert.mli
  • src/lib_webassembly/exec/f64_convert.mli
  • src/lib_webassembly/exec/i32_convert.mli
  • src/lib_webassembly/exec/i64_convert.mli
  • src/lib_webassembly/exec/v128.mli
  • src/lib_webassembly/extra/parse.mli
  • src/lib_webassembly/runtime/func.mli
  • src/lib_webassembly/runtime/global.mli
  • src/lib_webassembly/script/import.mli
  • src/lib_webassembly/syntax/free.mli
  • src/lib_webassembly/util/error.mli
  • src/lib_webassembly/util/lib.mli
  • src/lib_webassembly/util/source.mli
  • src/proto_alpha/lib_client/client_proto_args.mli
  • src/proto_alpha/lib_client/client_proto_multisig.mli
  • src/proto_alpha/lib_client/client_proto_rollups.mli
  • src/proto_alpha/lib_client/client_proto_tzt.mli
  • src/proto_alpha/lib_client/client_proto_utils.mli
  • src/proto_alpha/lib_client/michelson_v1_emacs.mli
  • src/proto_alpha/lib_client/michelson_v1_error_reporter.mli
  • src/proto_alpha/lib_client/michelson_v1_macros.mli
  • src/proto_alpha/lib_client/michelson_v1_stack.mli
  • src/proto_alpha/lib_client/operation_result.mli
  • src/proto_alpha/lib_client_commands/client_proto_stresstest_commands.mli
  • src/proto_alpha/lib_dal/dal_proto_client.mli
  • src/proto_alpha/lib_dal/dal_slot_frame_encoding.mli
  • src/proto_alpha/lib_delegate/abstract_context_index.mli
  • src/proto_alpha/lib_delegate/baking_actions.mli
  • src/proto_alpha/lib_delegate/baking_commands.mli
  • src/proto_alpha/lib_delegate/baking_files.mli
  • src/proto_alpha/lib_delegate/baking_highwatermarks.mli
  • src/proto_alpha/lib_delegate/baking_vdf.mli
  • src/proto_alpha/lib_delegate/client_baking_blocks.mli
  • src/proto_alpha/lib_delegate/client_baking_denunciation.mli
  • src/proto_alpha/lib_parameters/default_parameters.mli
  • src/proto_alpha/lib_plugin/script_interpreter_logging.mli
  • src/proto_alpha/lib_protocol/lazy_storage_diff.mli
  • src/proto_alpha/lib_protocol/liquidity_baking_migration.mli
  • src/proto_alpha/lib_protocol/operation_costs.mli
  • src/proto_alpha/lib_protocol/ratio_repr.mli
  • src/proto_alpha/lib_protocol/sc_rollup_riscv.mli
  • src/proto_alpha/lib_protocol/sc_rollup_staker_index_repr.mli
  • src/proto_alpha/lib_protocol/ticket_amount.mli
  • src/proto_alpha/lib_protocol/votes_EMA_repr.mli
  • src/proto_alpha/lib_sc_rollup_layer2/sc_rollup_proto_types.mli
  • src/proto_demo_counter/lib_client/client_proto_args.mli
  • src/proto_demo_counter/lib_client/client_proto_commands.mli
  • src/proto_demo_counter/lib_client/protocol_client_context.mli
  • src/proto_demo_counter/lib_protocol/header.mli
  • src/proto_demo_counter/lib_protocol/proto_operation.mli
  • src/proto_demo_counter/lib_protocol/services.mli
  • src/proto_genesis/lib_client/client_proto_main.mli
  • src/riscv/lib/octez_riscv_api.mli
Edited by Nic Volanschi