cardano-serialization-lib icon indicating copy to clipboard operation
cardano-serialization-lib copied to clipboard

no documentation

Open prerak01 opened this issue 2 years ago • 3 comments

Can you please provide a documentation for this library? A list of the methods would be nice. The cardano docs link which is linked in place of documentation is extremely insufficient.

prerak01 avatar May 21 '22 21:05 prerak01

You can check out docs.rs if you just want the list of methods (every crate published on crates.io gets an auto-generate docs.rs page).

In my opinion though, the auto-generated documentation doesn't help me understand what is a ScriptAll and how it differs from its 4 other similarly named structs.

Personally I tried looking at some examples, like:

kugiyasan avatar Jun 15 '22 16:06 kugiyasan

Check out this file: https://github.com/Emurgo/cardano-serialization-lib/blob/master/rust/src/tx_builder.rs Starting at line 1455, #[cfg(test)]

The examples there are really helpful :)

danbigthink avatar Jun 22 '22 19:06 danbigthink

We are working hard to provide good documentation and an interface layer for cardano serialization library. Check out Mesh.

jinglescode avatar Oct 12 '22 10:10 jinglescode