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

[RFE] Explain tables in Aptos #5517

Open
clay-aptos opened this issue Nov 9, 2022 · 12 comments
Open

[RFE] Explain tables in Aptos #5517

clay-aptos opened this issue Nov 9, 2022 · 12 comments
Assignees
Labels
documentation Improvements or additions to documentation P0 stale-exempt Prevents issues from being automatically marked and closed as stale

Comments

@clay-aptos
Copy link
Contributor

RFE

Tables are a common area of confusion in Aptos. We should explain them, building upon a definition proposed in:
#5434

See the sources we have now:
https://github.com/aptos-labs/aptos-core/blob/main/aptos-move/framework/aptos-stdlib/sources/table.move
https://aptos.dev/guides/move-guides/guide-move-transactional-testing/#view-tables
https://github.com/aptos-labs/aptos-core/blob/main/aptos-move/framework/aptos-stdlib/doc/table.md#0x1_table

Note, the second link isn't in navigation. We should fix that too. Asking @banool and @movekevin for guidance and help.

@clay-aptos clay-aptos added the bug Something isn't working label Nov 9, 2022
@clay-aptos clay-aptos added documentation Improvements or additions to documentation P0 labels Nov 9, 2022
@crazybits
Copy link

crazybits commented Nov 17, 2022

how to deserialize table from raw bytes to rust struct with bcs,any sample for reference?

@geekflyer geekflyer removed the bug Something isn't working label Nov 21, 2022
@clay-aptos
Copy link
Contributor Author

@clay-aptos clay-aptos linked a pull request Dec 16, 2022 that will close this issue
@clay-aptos
Copy link
Contributor Author

I have started a glossary entry for Table here:
#5897

And I am linking to @banool 's excellent Stack Overflow answer here:
https://stackoverflow.com/questions/74296605/given-a-key-how-do-i-read-the-value-from-a-table-via-the-api

I would love to publish these instructions, still not in site navigation:
https://aptos.dev/guides/move-guides/guide-move-transactional-testing/#view-tables

Team, please advise. Thanks!

@clay-aptos clay-aptos moved this to 👀 In review in Aptos Docs Jan 6, 2023
@clay-aptos
Copy link
Contributor Author

We have removed the Stack Overflow link. Please take another look:
#5897

@clay-aptos
Copy link
Contributor Author

We are live!
https://aptos.dev/reference/glossary#table

Closing this out as all I could muster here. If someone else wants to contribute, I'd love that.

@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Aptos Docs Jan 26, 2023
@clay-aptos clay-aptos reopened this Mar 9, 2023
@clay-aptos clay-aptos moved this from ✅ Done to 📋 Need input in Aptos Docs Mar 9, 2023
@clay-aptos
Copy link
Contributor Author

Reopening to see if we can get more details in the docs.

@wrwg
Copy link
Contributor

wrwg commented Mar 22, 2023

What is about the reference docs generated from the source?

@clay-aptos
Copy link
Contributor Author

What is about the reference docs generated from the source?

This?
https://github.com/aptos-labs/aptos-core/blob/main/aptos-move/framework/aptos-stdlib/doc/table.md

We link from:
https://aptos.dev/reference/glossary#table

Yet I don't know if that addresses this particular request. Perhaps we should also reference table use from our guides to demonstrate use.

Wolfgang, what do you think? Thanks!

@lbmeiyi lbmeiyi removed the Q223 label Apr 24, 2023
@lbmeiyi lbmeiyi moved this from 🎉 New to 🦆 Todo in Developer Experience Apr 24, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2023

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

@github-actions github-actions bot added the Stale label Jun 9, 2023
@banool banool moved this from 🦆 Todo to ⏳ Backlog in Developer Experience Jun 21, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jun 24, 2023
@github-project-automation github-project-automation bot moved this from 📋 Need input to ✅ Done in Aptos Docs Jun 24, 2023
@github-project-automation github-project-automation bot moved this from ⏳ Backlog to ✅ Done in Developer Experience Jun 24, 2023
@brmataptos
Copy link
Contributor

The docgen from the code doesn't have enough explanation.

@brmataptos brmataptos reopened this Jun 29, 2023
@github-actions github-actions bot removed the Stale label Jun 30, 2023
@github-actions
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

@github-actions github-actions bot added the Stale label Aug 15, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Aug 30, 2023
@brmataptos brmataptos reopened this Aug 30, 2023
@brmataptos
Copy link
Contributor

Still not fixed. This should be stale-exempt.

@brmataptos brmataptos added the stale-exempt Prevents issues from being automatically marked and closed as stale label Aug 30, 2023
@github-actions github-actions bot removed the Stale label Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P0 stale-exempt Prevents issues from being automatically marked and closed as stale
Projects
Archived in project
Archived in project
Development

Successfully merging a pull request may close this issue.

10 participants