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

[documentation] #2113: Document features in Cargo.toml files #2180

Merged

Conversation

outoftardis
Copy link
Contributor

@outoftardis outoftardis commented May 6, 2022

Signed-off-by: Ekaterina Mekhnetsova [email protected]

Description of the Change

Provide descriptions of features in Cargo.toml files

Issue

Closes #2113

@github-actions github-actions bot added the iroha2-dev The re-implementation of a BFT hyperledger in RUST label May 6, 2022
@outoftardis outoftardis added the Documentation Documentation changes label May 6, 2022
cli/Cargo.toml Outdated Show resolved Hide resolved
core/Cargo.toml Outdated Show resolved Hide resolved
core/Cargo.toml Outdated Show resolved Hide resolved
tools/parity_scale_decoder/Cargo.toml Outdated Show resolved Hide resolved
version/Cargo.toml Outdated Show resolved Hide resolved
@s8sato s8sato self-assigned this May 6, 2022
@outoftardis outoftardis force-pushed the add-doc-cargo branch 2 times, most recently from f76a2e4 to 31cc2e2 Compare May 6, 2022 07:20
@codecov
Copy link

codecov bot commented May 6, 2022

Codecov Report

Merging #2180 (884d92b) into iroha2-dev (4f03342) will increase coverage by 76.36%.
The diff coverage is n/a.

❗ Current head 884d92b differs from pull request most recent head 0a18ece. Consider uploading reports for the commit 0a18ece to get more accurate results

@@               Coverage Diff               @@
##           iroha2-dev    #2180       +/-   ##
===============================================
+ Coverage            0   76.36%   +76.36%     
===============================================
  Files               0      184      +184     
  Lines               0    26151    +26151     
===============================================
+ Hits                0    19971    +19971     
- Misses              0     6180     +6180     
Impacted Files Coverage Δ
config/src/lib.rs 16.66% <0.00%> (ø)
client/tests/mod.rs 100.00% <0.00%> (ø)
actor/src/lib.rs 89.96% <0.00%> (ø)
schema/derive/tests/ui.rs 14.28% <0.00%> (ø)
core/src/smartcontracts/isi/mod.rs 77.23% <0.00%> (ø)
futures/src/lib.rs 60.93% <0.00%> (ø)
core/src/smartcontracts/isi/query.rs 83.09% <0.00%> (ø)
core/test_network/tests/sumeragi_with_mock.rs 0.30% <0.00%> (ø)
core/src/smartcontracts/isi/expression.rs 84.58% <0.00%> (ø)
logger/tests/configuration.rs 96.29% <0.00%> (ø)
... and 174 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4f03342...0a18ece. Read the comment docs.

appetrosyan
appetrosyan previously approved these changes May 6, 2022
tools/parity_scale_decoder/Cargo.toml Outdated Show resolved Hide resolved
appetrosyan
appetrosyan previously approved these changes May 6, 2022
std = ["iroha_macro/std", "parity-scale-codec/std", "thiserror"]
# Derive the version trait, which allows API versioning of transactions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only transactions but also queries and websocket messages are versioned.
If we describe this, I think we should do in the top of iroha_version crate

Suggested change
# Derive the version trait, which allows API versioning of transactions
# Enable macros for versioning

To be left to another PR:

  • I just realized iroha_version_derive contains no derive macros. The crate can be renamed
  • I wonder why this feature is feature because the macros seem to be essential to the crate

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated the wording

version/Cargo.toml Outdated Show resolved Hide resolved
Comment on lines +21 to 22
# Support the included CLI
cli = []
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a question, what use cli feature will have in the future @appetrosyan ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully it can be factored out and removed. My assumption at the time was to make our current CLI implementation optional. As our experience with roles demonstrated, it's not worth the overhead.

@appetrosyan appetrosyan merged commit faf96c3 into hyperledger-iroha:iroha2-dev May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation changes iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants