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(protocol): remove internal variables and functions' #401

Closed
dantaik opened this issue Dec 9, 2022 · 5 comments
Closed

docs(protocol): remove internal variables and functions' #401

dantaik opened this issue Dec 9, 2022 · 5 comments
Assignees

Comments

@dantaik
Copy link
Contributor

dantaik commented Dec 9, 2022

Describe the feature request

In the current smart contract documentation, for example https://taiko.xyz/docs/reference/smart-contracts/L2/TaikoL2, we need to remove private and internal state variables and functions:

  • __gap
  • _checkPublicInputs
  • _hashPublicInputs

Describe alternatives you've considered

No response

Additional context

No response

@1xDeFi
Copy link
Contributor

1xDeFi commented Dec 12, 2022

I tried to remove it from some of the pages.
If I'm doing it right, let me know to fix the rest of the pages.

#419
#418
#417
#416
#415

@dionysuzx
Copy link
Collaborator

dionysuzx commented Dec 12, 2022

I tried to remove it from some of the pages. If I'm doing it right, let me know to fix the rest of the pages.

#419 #418 #417 #416 #415

left a comment on one of them @1xDeFi

@dionysuzx dionysuzx changed the title docs(protocol): remove internal variables and functions docs(protocol): remove internal variables and functions' Dec 14, 2022
@dantaik
Copy link
Contributor Author

dantaik commented Jan 3, 2023

When we change the source code, these docs will be auto-generated again, then we need to manually remove these internal vars again, don't we? @d1onys1us

@dionysuzx
Copy link
Collaborator

When we change the source code, these docs will be auto-generated again, then we need to manually remove these internal vars again, don't we? @d1onys1us

yes, that's right. there is a way we can actually fix this. i will give it a shot today.

@dionysuzx dionysuzx moved this from 📝 Todo to 🏗 In progress in Taiko Project Board Jan 3, 2023
@dionysuzx
Copy link
Collaborator

When we change the source code, these docs will be auto-generated again, then we need to manually remove these internal vars again, don't we? @d1onys1us

yes, that's right. there is a way we can actually fix this. i will give it a shot today.

now this is done here: #490

@dionysuzx dionysuzx moved this from 🏗 In progress to 📝 Todo in Taiko Project Board Jan 3, 2023
@dionysuzx dionysuzx moved this from 📝 Todo to 👀 In review in Taiko Project Board Jan 3, 2023
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Taiko Project Board Jan 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

3 participants