docs(sn_client): Basic documentation #1946

mazzi · 2024-07-05T16:36:03Z

Adding basic documentation for sn_client.

Description, features, examples.

Please mark the types of changes made in this pull request.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update
Other (please describe):

sn_client/examples/file-mgmt-files.rs

+    println!("Payment for chunks: {:?}", payment.storage_cost);
+
+    // Upload the file. First add the file to the folder
+    //TODO:


sn_client/examples/file-mgmt-files.rs

+use tokio::main;
+use xor_name::XorName;
+
+// FIXME: This example is WIP.


sn_client/README.md

sn_client/src/api.rs

sn_client/README.md

sn_client/src/api.rs

maqi

PR has 23 commits in the change history, but just 43 lines changed ?

mazzi requested a review from RolandSherwin July 5, 2024 16:36

github-advanced-security bot found potential problems Jul 5, 2024

View reviewed changes

mazzi force-pushed the doc_sn_client branch 2 times, most recently from 1e96457 to 1048c9f Compare July 5, 2024 16:43

RolandSherwin force-pushed the doc_sn_client branch from 1048c9f to 9930725 Compare July 6, 2024 09:06

mazzi force-pushed the doc_sn_client branch 2 times, most recently from 3346100 to c377d80 Compare July 11, 2024 15:02

mazzi requested review from b-zee and grumbach July 11, 2024 15:19

mazzi marked this pull request as ready for review July 15, 2024 09:09