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

Finish all documentation #105

Open
kevin-pease opened this issue Aug 21, 2024 · 0 comments
Open

Finish all documentation #105

kevin-pease opened this issue Aug 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kevin-pease
Copy link
Contributor

kevin-pease commented Aug 21, 2024

There is still missing documentation throughout the stellar_rust_sdk, including:

  • offers: OffersForAccountRequest
  • order_book: DetailsRequest, mod.rs
  • payments: AllPaymentsRequest, PaymentsForAccountRequest, PaymentsForLedgerRequest, PaymentForTransactionRequest, mod.rs
  • trades: TradesForAccountRequest, TradesForLiquidityPoolRequest, TradesForOfferRequest
  • transactions: SingleTransactionRequest, TransactionsForAccountRequest, TransactionsForLedgerRequest, TransactionsForLiquidityPoolRequest, account_muxed field in response
  • fee_stats: mod.rs (prelude)
  • models: mod.rs (prelude)

Additionally, there are some minor issues with existing documentation, including:

  • horizon_client.rs: documentation for get_all_offers mentions the return type OfferResponse, this should be AllOffersResponse
  • lib.rs: documentation for offers mentions "fetching all effects" in code example
  • offers: mod.rs, update prelude documentation
  • trades: all_trades_request.rs: AssetData: change // to ///
@kevin-pease kevin-pease added the documentation Improvements or additions to documentation label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant