Flow Rust SDK Milestone 4 #42
Conversation
sh-add ~/Marshall-DEV.pem >/dev/null 2>&1
|
Hi @MarshallBelles - for tracking purposes, would you mind splitting this up into 3 PRs corresponding to the milestones? If possible, point to the relevant repo (potentially specific directories) on how those milestones have been met. |
|
@MarshallBelles Great work! I had a look at https://github.com/MarshallBelles/flow-rust-sdk/blob/release/src/lib.rs and you are off to a great start 👍 As far as I can tell, it currently looks like each of the functions making a network request (e.g. |
Very good point. This will also allow the developer to manage their own connection pools. |
|
@MarshallBelles Great Rust library. I have two pieces of feedback. First is an architectural improvement, where you could extract networking functionality into another layer only exposing the API which would also allow you to swap the implementation with mock for testing. Not a high priority but a possible improvement. The second is about the documentation, although I really like the documentation you already are making I would keep that more as a reference whereas documentation that would be included in our docs page should be shaped in another format. I will provide you with examples and templates for that format before you finish. |
|
@sideninja I’m all ears. Documentation is my weak point. Networking should be abstracted into another layer, I totally agree. |
@MarshallBelles Sorry for taking longer (I got sick) but expect documentation templates in the beginning of next week, so you will be able to just provide code examples and that will complete the docs part. |
Documentation templates would be very helpful! I'm planning on using the docs.rs simply as an API reference. I will probably utilize the Github Wiki for tutorials and usage instructions. |
I'll try to get this done sometime next week. |
|
@MarshallBelles I accidentally merged in this PR as I was merging your milestone 1 and 2 that were approved. I ended up having to delete the submission file for milestone 4 after - would you mind re-opening another one for Milestone 4 once you are complete? Sorry for the inconvenience. |
|
No problem. I’ll get to it soon.
…________________________________
From: srinjoyc ***@***.***>
Sent: Wednesday, October 20, 2021 10:43 AM
To: onflow/flip-fest
Cc: MarshallBelles; Mention
Subject: Re: [onflow/flip-fest] Flow Rust SDK Milestone 4 (#42)
@MarshallBelles<https://github.com/MarshallBelles> I accidentally merged in this PR as I was merging your milestone 1 and 2 that were approved. I ended up having to delete the submission file for milestone 4 after - would you mind re-opening another one for Milestone 4 once you are complete? Sorry for the inconvenience.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#42 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AGUL622HQJTIXJB3ZEWCUCDUH3IPZANCNFSM5EWGAW6Q>.
Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
|
|
@MarshallBelles the new documentation template can be found at https://github.com/onflow/sdks/tree/main/templates/documentation |
|
Thanks a bunch, this is epic!
…________________________________
From: Gregor Gololicic ***@***.***>
Sent: Tuesday, October 26, 2021 2:02 PM
To: onflow/flip-fest
Cc: MarshallBelles; Mention
Subject: Re: [onflow/flip-fest] Flow Rust SDK Milestone 4 (#42)
@MarshallBelles<https://github.com/MarshallBelles> the new documentation template can be found at https://github.com/onflow/sdks/tree/main/templates/documentation
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#42 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AGUL62YDPLUGFW2JMVI5DL3UI33M7ANCNFSM5EWGAW6Q>.
Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
|
Flow-Rust-SDK - Milestone 4 [WIP]
This PR is for issue #20.
Current Status
The Flow-Rust-SDK is feature complete, meaning that as a user you can accomplish any task you need to do.
Documentation is almost completed.
Milestones
Authors include: