Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[suggestion] Get rid of "rustisms" in the configuration reference #3505

Closed
0x009922 opened this issue May 21, 2023 · 4 comments
Closed

[suggestion] Get rid of "rustisms" in the configuration reference #3505

0x009922 opened this issue May 21, 2023 · 4 comments
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

Comments

@0x009922
Copy link
Contributor

0x009922 commented May 21, 2023

Feature request

For the end user, it doesn't make sense:

  • to mention things like Option<..>, Option<Option<..>> and explaining "what does it mean to them"
  • to say that some field is of type std::path::PathBuf when it simply means that it is a string
  • to mention structs like PublicKey, PrivateKey, PeerId without explaining their structure

Configuration 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.

@0x009922 0x009922 added Enhancement New feature or request iroha2-dev The re-implementation of a BFT hyperledger in RUST Documentation Documentation changes config-changes Changes in configuration and start up of the Iroha labels May 21, 2023
@appetrosyan
Copy link
Contributor

I'd suggest expanding the tutorial section with these structures and explaining what those mean and what to do about them. Rust-isms aren't a problem in and of themselves, Iroha has many Rust sensibilities anyway. The problem is that they're all undocumented.

@0x009922
Copy link
Contributor Author

I'd suggest expanding the tutorial section with these structures and explaining what those mean and what to do about them.

Yes, I am talking about that. The point is to explain such structures not in terms of Rust, but in terms of the config format (e.g. as JSON schema).

@appetrosyan
Copy link
Contributor

Being more precise with our language helps the potential implementor.

@0x009922
Copy link
Contributor Author

Auto-generated configuration reference was removed. New reference:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants