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 Request: Balance between too much info, and arbitrary ordering of structs breaking erc-20 #434

Open
briandoyle81CB opened this issue Apr 10, 2024 · 1 comment
Assignees
Labels
type: docs New docs or changes to existing

Comments

@briandoyle81CB
Copy link
Contributor

What is the issue you are encountering with the docs?

typeof.eth — 04/05/2024 8:49 PM
Minor feedback: one of my mentees was having trouble with the ERC20 exercise due to one of her function signatures being off due to the Issue struct.

IMO, explaining how function selectors work and how structs are really just tuples is probably not worth it for new peeps, so I wonder if it would help to provide the expected struct upfront rather than describe the structs and assume they’ll be defined in the order that they’re described.

Because the unit tests expect a specific ABI, I’d probably choose to provide the whole interface that has the methods and structs that the tests expect, but idk, that might be giving away too much.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/erc-20-token/erc-20-exercise/

Describe the solution you'd like to see.

Brian needs to find a better balance here

Additional context

No response

@briandoyle81CB briandoyle81CB added the type: docs New docs or changes to existing label Apr 10, 2024
@briandoyle81CB briandoyle81CB self-assigned this Apr 10, 2024
@whyte01
Copy link

whyte01 commented Apr 25, 2024

Awesome

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs New docs or changes to existing
Projects
None yet
Development

No branches or pull requests

2 participants