Skip to content

doc: picodata run --script option description

Yaroslav Dynnikov requested to merge enhance-doc into master

Also fix some rustdoc warnings

 Documenting picodata v23.6.0 (/home/rosik/w/picodata)
warning: unresolved link to `host`
   --> src/args.rs:324:52
    |
324 |     /// Picodata instance address. Format: [user@][host][:port]
    |                                                    ^^^^ no item named `host` in scope
    |
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

warning: unresolved link to `:port`
   --> src/args.rs:324:58
    |
324 |     /// Picodata instance address. Format: [user@][host][:port]
    |                                                          ^^^^^ no item named `:port` in scope
    |
    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

warning: unresolved link to `rpc::cas::Error`
  --> src/cas.rs:38:11
   |
38 | /// See [`rpc::cas::Error`] for CaS-specific errors.
   |           ^^^^^^^^^^^^^^^ no item named `cas` in module `rpc`

warning: public documentation for `apply_snapshot_data` links to private item `crate::traft::node::NodeImpl::advance`
   --> src/storage.rs:549:32
    |
549 |     /// [`NodeImpl::advance`]: crate::traft::node::NodeImpl::advance
    |                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ this item is private
    |
    = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
    = note: this link resolves only because you passed `--document-private-items`, but will break without

warning: `picodata` (lib doc) generated 4 warnings
    Finished dev [unoptimized + debuginfo] target(s) in 2.84s

Merge request reports