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

Properly define and document our public interface #656

Merged
merged 52 commits into from
May 5, 2023
Merged

Conversation

plafer
Copy link
Contributor

@plafer plafer commented May 2, 2023

Closes: #376
Closes: #235
Closes: #597

Description

This PR is best review by running

cargo doc --open

and looking at the docs there


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests.
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@codecov
Copy link

codecov bot commented May 2, 2023

Codecov Report

Patch coverage: 47.36% and project coverage change: -0.42 ⚠️

Comparison is base (aeac915) 73.08% compared to head (0d5cd8f) 72.67%.

❗ Current head 0d5cd8f differs from pull request most recent head 57b9468. Consider uploading reports for the commit 57b9468 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #656      +/-   ##
==========================================
- Coverage   73.08%   72.67%   -0.42%     
==========================================
  Files         127      122       -5     
  Lines       15637    15756     +119     
==========================================
+ Hits        11429    11450      +21     
- Misses       4208     4306      +98     
Impacted Files Coverage Δ
...s/ibc/src/applications/transfer/acknowledgement.rs 82.65% <ø> (ø)
crates/ibc/src/applications/transfer/amount.rs 53.33% <ø> (ø)
crates/ibc/src/applications/transfer/coin.rs 83.33% <ø> (ø)
crates/ibc/src/applications/transfer/context.rs 51.81% <ø> (ø)
crates/ibc/src/applications/transfer/denom.rs 77.29% <ø> (ø)
crates/ibc/src/applications/transfer/error.rs 12.50% <ø> (-1.14%) ⬇️
crates/ibc/src/applications/transfer/events.rs 17.85% <ø> (ø)
crates/ibc/src/applications/transfer/memo.rs 35.00% <ø> (ø)
...tes/ibc/src/applications/transfer/msgs/transfer.rs 46.78% <ø> (-3.71%) ⬇️
crates/ibc/src/applications/transfer/packet.rs 52.38% <ø> (ø)
... and 100 more

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@plafer plafer marked this pull request as ready for review May 4, 2023 20:41
@plafer plafer requested a review from Farhad-Shabani May 4, 2023 20:41
Copy link
Member

@Farhad-Shabani Farhad-Shabani left a comment

Choose a reason for hiding this comment

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

Got way cleaner. Superb!

Just a unclog should be added. 🙏

@Farhad-Shabani
Copy link
Member

Reminder: remove ClientTypePath after updating the branch with the main

DaviRain-Su and others added 4 commits May 5, 2023 12:52
* Add serialization for various structs and enums

* Create 652-codec-borsh-serde.md

---------

Signed-off-by: Davirain <davirain.yin@gmail.com>
@plafer
Copy link
Contributor Author

plafer commented May 5, 2023

Right;
changelog: 513d61a
ClientTypePath removed: 405434d

@plafer plafer merged commit ee16dc2 into main May 5, 2023
@plafer plafer deleted the plafer/376-docstrings branch May 5, 2023 17:47
@plafer plafer mentioned this pull request May 5, 2023
Farhad-Shabani added a commit that referenced this pull request Sep 9, 2024
* some docstrings updated

* Remove dynamic_typing module

* move some utils to tendermint client

* Make `crate::utils` private

* docs

* Remove unused struct

* move events under core

* move timestamp under core

* Move tx_msg under core

* Make naming convention comment not module-level

* Make core::handler private

* Re-export all core::context

* make tx_msg private and re-export Msg

* core module docs

* many docs improvements

* Release v0.39.0 (#657)

* unclog release

* bump version

* Correct issue 621 description

---------

Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com>

* fix doc test

* `Validation/ExecutionContext` method docs

* more docs improvements

* remove unused function

* client docs improvements

* move trust_threshold to tendermint

* connection

* finish ics-20 docs

* finish docs for the tendermint light client

* core docs

* move `ModuleExtras` out of channel

* Make all `TYPE_URL` private

* Move `Acknowledgement `

* remove superfluous channel message modules

* finish channel docs

* Remove `ics05_port` module

* ValidationError -> IdentifierError

* remove error module

* cleanup ics24_host path

* move host validate module under identifier

* move RouterError

* move msgs under core

* remove tx_msg

* router module

* remove arbitrary restrictions on `ModuleId`

* router

* finish ics23

* mock

* fmt

* Add serialization for various structs and enums (#653)

* Add serialization for various structs and enums

* Create 652-codec-borsh-serde.md

---------

Signed-off-by: Davirain <davirain.yin@gmail.com>

* changelog

* remove `ClientTypePath`

---------

Signed-off-by: Davirain <davirain.yin@gmail.com>
Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com>
Co-authored-by: Davirain <davirain.yin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
3 participants