[suggestion] Get rid of "rustisms" in the configuration reference #3505
Labels
config-changes
Changes in configuration and start up of the Iroha
Documentation
Documentation changes
Enhancement
New feature or request
iroha2-dev
The re-implementation of a BFT hyperledger in RUST
Feature request
For the end user, it doesn't make sense:
Option<..>
,Option<Option<..>>
and explaining "what does it mean to them"std::path::PathBuf
when it simply means that it is a stringPublicKey
,PrivateKey
,PeerId
without explaining their structureConfiguration parameters types and values examples should be explained in respect of the configuration format itself, i.e. JSON (or TOML #3499). In other words, use
null
,number
,string
and other format-related types.Motivation
Make clear to user what they should put into the configuration.
The text was updated successfully, but these errors were encountered: