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

[ci] #1658: Add documentation check #2367

Merged

Conversation

ales-tsurko
Copy link
Contributor

Sorry for omitting the PR template here, but the change is very little and clear. It just adds documentation check (using cargo doc) to CI.

@github-actions github-actions bot added the iroha2-dev The re-implementation of a BFT hyperledger in RUST label Jun 16, 2022
@codecov
Copy link

codecov bot commented Jun 16, 2022

Codecov Report

Merging #2367 (34a4919) into iroha2-dev (6973f71) will increase coverage by 1.52%.
The diff coverage is 64.62%.

❗ Current head 34a4919 differs from pull request most recent head c213d16. Consider uploading reports for the commit c213d16 to get more accurate results

@@              Coverage Diff               @@
##           iroha2-dev    #2367      +/-   ##
==============================================
+ Coverage       65.50%   67.02%   +1.52%     
==============================================
  Files             133      140       +7     
  Lines           24697    26282    +1585     
==============================================
+ Hits            16177    17616    +1439     
- Misses           8520     8666     +146     
Impacted Files Coverage Δ
cli/derive/src/lib.rs 74.72% <ø> (ø)
cli/src/torii/mod.rs 28.88% <ø> (ø)
client/src/http.rs 47.82% <ø> (ø)
config/src/lib.rs 15.38% <0.00%> (+1.09%) ⬆️
core/src/lib.rs 100.00% <ø> (ø)
core/src/smartcontracts/isi/account.rs 12.30% <ø> (ø)
core/src/smartcontracts/isi/block.rs 100.00% <ø> (ø)
core/src/smartcontracts/isi/domain.rs 39.82% <ø> (ø)
core/src/smartcontracts/isi/triggers.rs 0.00% <0.00%> (ø)
core/src/smartcontracts/isi/tx.rs 25.00% <ø> (ø)
... and 97 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 4412892...c213d16. Read the comment docs.

Copy link
Contributor

@pesterev pesterev left a comment

Choose a reason for hiding this comment

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

According to the CI report, a few comments need to be corrected to pass the CI checks.

@outoftardis outoftardis force-pushed the ci/1658-add-documentation-check branch 6 times, most recently from 84ff403 to 05fde26 Compare June 20, 2022 08:47
@@ -30,7 +30,7 @@ pub enum FfiResult {
Ok = 0_i32,
}

/// Implement [`Handle`] for given types with first argument as the initial handle id.
Copy link
Contributor

Choose a reason for hiding this comment

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

@ales-tsurko this is the only link that is still unresolved.
I think my knowledge of Rust is limited here to understand why all the syntax I'm trying is failing, so if you have any ideas how to fix this -- please do

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The problem caused by the Handle trait defined inside macro, so there's no trait definition until the macro is used. We have two options:

  1. define the trait outside the macro;
  2. don't link documentation for the trait.

@appetrosyan what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe we can omit the link altogether? the description would still be clear even without the link

Copy link
Contributor

Choose a reason for hiding this comment

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

don't link documentation for the trait.

Is fine by me. We should avoid defining non-private traits inside macros, though.

ales-tsurko and others added 5 commits June 21, 2022 12:11
Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
@ales-tsurko ales-tsurko force-pushed the ci/1658-add-documentation-check branch from 34a4919 to c213d16 Compare June 21, 2022 09:11
Copy link
Contributor

@pesterev pesterev left a comment

Choose a reason for hiding this comment

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

LGTM

@appetrosyan appetrosyan merged commit c60954e into hyperledger:iroha2-dev Jun 21, 2022
@ales-tsurko ales-tsurko deleted the ci/1658-add-documentation-check branch June 21, 2022 12:06
BAStos525 pushed a commit to BAStos525/soramitsu-iroha that referenced this pull request Jul 8, 2022
Co-authored-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
Signed-off-by: BAStos525 <jungle.vas@yandex.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants