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

docs: add docs to contract interfaces #175

Merged
merged 15 commits into from
Jan 28, 2025
Merged

Conversation

TanvirDeol
Copy link
Contributor

@TanvirDeol TanvirDeol commented Jan 22, 2025

AXE-5852

Added documentation for interchain-token and axelar-operators

@TanvirDeol TanvirDeol requested a review from a team as a code owner January 22, 2025 05:41
@codecov-commenter
Copy link

codecov-commenter commented Jan 22, 2025

Codecov Report

Attention: Patch coverage is 83.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 95.57%. Comparing base (4da911b) to head (e826c40).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...ontracts/stellar-axelar-operators/src/interface.rs 0.00% 1 Missing ⚠️
contracts/stellar-example/src/contract.rs 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #175      +/-   ##
==========================================
- Coverage   95.60%   95.57%   -0.03%     
==========================================
  Files          67       68       +1     
  Lines        3638     3642       +4     
==========================================
+ Hits         3478     3481       +3     
- Misses        160      161       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

contracts/axelar-operators/src/interface.rs Outdated Show resolved Hide resolved
contracts/axelar-operators/src/interface.rs Outdated Show resolved Hide resolved
contracts/axelar-operators/src/interface.rs Outdated Show resolved Hide resolved
contracts/interchain-token/src/interface.rs Outdated Show resolved Hide resolved
contracts/interchain-token/src/interface.rs Outdated Show resolved Hide resolved
contracts/interchain-token/src/interface.rs Outdated Show resolved Hide resolved
contracts/interchain-token/src/interface.rs Outdated Show resolved Hide resolved
contracts/interchain-token/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-operators/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-upgrader/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-upgrader/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-operators/src/lib.rs Outdated Show resolved Hide resolved
contracts/stellar-example/src/lib.rs Show resolved Hide resolved
@TanvirDeol
Copy link
Contributor Author

TanvirDeol commented Jan 25, 2025

@Milap Do you want me to apply changes like

  • Remove “Returns: Ok(())
  • Put error codes in brackets [] to make them linkable in docs
  • replace authenticate w/ authorize
  • Must be called by [Self::owner] —> [Self::owner] must authorize.
  • etc

to stellar-interchain-token-service?

contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-gas-service/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-axelar-operators/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-example/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-example/src/interface.rs Outdated Show resolved Hide resolved
contracts/stellar-interchain-token/src/interface.rs Outdated Show resolved Hide resolved
@milapsheth milapsheth changed the title docs: add docstring/comments to interface files docs: add docs to contract interfaces Jan 28, 2025
@milapsheth milapsheth enabled auto-merge (squash) January 28, 2025 08:17
@milapsheth milapsheth merged commit 2f17e32 into main Jan 28, 2025
5 checks passed
@milapsheth milapsheth deleted the docs/axelar-cgp-stellar branch January 28, 2025 08:18
@talalashraf talalashraf mentioned this pull request Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants