Skip to content

Conversation

@DaughterOfMars
Copy link
Contributor

@DaughterOfMars DaughterOfMars commented Aug 18, 2025

Description

Adds docs back to the remote derived FFI types.

Closes #94

@DaughterOfMars DaughterOfMars linked an issue Aug 18, 2025 that may be closed by this pull request
@thibault-martinez
Copy link
Member

The issue wasn't about remote derived types only though

@DaughterOfMars
Copy link
Contributor Author

The issue wasn't about remote derived types only though

Yes but those are the only types I excluded docs on

@thibault-martinez
Copy link
Member

The issue wasn't about remote derived types only though

Yes but those are the only types I excluded docs on

Example of a non-remote type with no docs on the FFI but docs on the base: https://github.com/iotaledger/iota-rust-sdk/blob/chore/remote-docs/crates/iota-sdk-ffi/src/graphql.rs#L35-L36

Haven't checked but I'm assuming there is more.

@DaughterOfMars
Copy link
Contributor Author

The issue wasn't about remote derived types only though

Yes but those are the only types I excluded docs on

Example of a non-remote type with no docs on the FFI but docs on the base: https://github.com/iotaledger/iota-rust-sdk/blob/chore/remote-docs/crates/iota-sdk-ffi/src/graphql.rs#L35-L36

Haven't checked but I'm assuming there is more.

Pretty sure that's the only instance

@thibault-martinez
Copy link
Member

thibault-martinez commented Aug 19, 2025

The issue wasn't about remote derived types only though

Yes but those are the only types I excluded docs on

Example of a non-remote type with no docs on the FFI but docs on the base: https://github.com/iotaledger/iota-rust-sdk/blob/chore/remote-docs/crates/iota-sdk-ffi/src/graphql.rs#L35-L36
Haven't checked but I'm assuming there is more.

Pretty sure that's the only instance

  • CheckpointCommitment
  • MultisigMemberPublicKey
  • ObjectData
  • Owner
  • ObjectType
  • TransactionEffects

@DaughterOfMars
Copy link
Contributor Author

  • TransactionEffects

not sure how these got merged :c

@thibault-martinez thibault-martinez merged commit a28159d into sdk-bindings Aug 19, 2025
7 checks passed
@thibault-martinez thibault-martinez deleted the chore/remote-docs branch August 19, 2025 11:32
Thoralf-M pushed a commit that referenced this pull request Aug 19, 2025
* chore(ffi): Add docs to remote impls

* update bindings

* add graphql client doc

* bindings

* add more missing comments

* bindings again

---------

Co-authored-by: Thibault Martinez <[email protected]>
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.

Put all available documentation in the FFI crate

4 participants