Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update utils.mdx #18782

Merged
merged 1 commit into from
Jul 25, 2024
Merged

[Docs] Update utils.mdx #18782

merged 1 commit into from
Jul 25, 2024

Conversation

CarryWang
Copy link
Contributor

Description

According to the function definition, the Docs description is backwards

function fromB64 receive base64 string return Uint8Array

But in the description of the Docs it is the opposite :

fromB64: Serializes a Uint8Array to a base64 string

image image

Test plan

How did you test the new or updated feature?


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

According to the function definition, the description is backwards
@CarryWang CarryWang requested a review from a team as a code owner July 24, 2024 08:29
Copy link

vercel bot commented Jul 24, 2024

@CarryWang is attempting to deploy a commit to the Mysten Labs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Jul 24, 2024

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

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 24, 2024 8:31am

@CarryWang CarryWang changed the title Update utils.mdx [Docs] Update utils.mdx Jul 24, 2024
Copy link
Contributor

@hayes-mysten hayes-mysten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@stefan-mysten stefan-mysten merged commit 2c3c774 into MystenLabs:main Jul 25, 2024
44 of 47 checks passed
suiwombat pushed a commit that referenced this pull request Sep 16, 2024
## Description 

According to the function definition, the Docs description is backwards

function `fromB64` receive `base64 string` return `Uint8Array`

But in the description of the Docs it is the opposite :

>`fromB64`: Serializes a Uint8Array to a base64 string

<img width="635" alt="image"
src="https://github.com/user-attachments/assets/16cf48c5-a620-46df-bb62-a5b1230791c1">
<img width="635" alt="image"
src="https://github.com/user-attachments/assets/9f0da79e-3fb4-4317-8a9e-30ea9f714f49">



## Test plan 

How did you test the new or updated feature?

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
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.

3 participants