Add comments to publish/upgrade methods in (Programmable)TransactionBuilder

[rockbmb]

Description

As a downstream consumer of sui-sdk, I found it a little difficult to understand how to use TransactionBuilder::{publish, upgrade} without jumping some IDE hoops.
Hopefully, the documentation added in this PR will help others who are also unfamiliar with the codebase.

Test Plan

No tests required.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
mysten-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 13, 2023 1:38am
sui-typescript-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 13, 2023 1:38am

3 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
explorer	⬜️ Ignored (Inspect)	Visit Preview		Nov 13, 2023 1:38am
multisig-toolkit	⬜️ Ignored (Inspect)	Visit Preview		Nov 13, 2023 1:38am
sui-kiosk	⬜️ Ignored (Inspect)	Visit Preview		Nov 13, 2023 1:38am

[oxade]

Thanks for bringing this to our attention and for putting up this PR! Please let us know if anything else could use better documentation.
I'll approve & merge this PR once the doc tests are fixed. Try adding "```rust,ignore" to the comments or using the proper type path

[rockbmb]

@oxade quick question: when you say

using the proper type path

do you mean for this PR to use relative paths?

I've taken a look at

• Figure out a way to link to downstream crates rust-lang/rust#74481, and
• Add guidance about linking to external crates rust-lang/api-guidelines#186

and it would seem this is the only way to have links in documentation that does not require introducing dependencies.

[oxade]

@oxade quick question: when you say

using the proper type path

do you mean for this PR to use relative paths?

I've taken a look at

• Figure out a way to link to downstream crates rust-lang/rust#74481, and
• Add guidance about linking to external crates rust-lang/api-guidelines#186

and it would seem this is the only way to have links in documentation that does not require introducing dependencies.

For simplicity, you could just use rust,ignore in the comments.

[OPTIMUS-PX]

Publish upgrade

[vercel]

@rockbmb is attempting to deploy a commit to the Sui Foundation Team on Vercel.

A member of the Team first needs to authorize it.

[rockbmb]

@oxade should be fixed, now.

By the way:

Please let us know if anything else could use better documentation.

I will - as I continue to use the SDK, I'll be submitting more PRs if I find anything I can help clarify for other users.

[github-actions]

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.