Skip to content

[DOCS] Incorrect variable 'abi' in system contracts docs #1007

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

Closed
huperts opened this issue Oct 19, 2024 · 0 comments · Fixed by #1008
Closed

[DOCS] Incorrect variable 'abi' in system contracts docs #1007

huperts opened this issue Oct 19, 2024 · 0 comments · Fixed by #1008
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation

Comments

@huperts
Copy link
Contributor

huperts commented Oct 19, 2024

Brief Description of the Docs Request

An error has been identified in the system contracts docs where the code snippet uses an undefined variable abi, which can lead to runtime issues.

Description of the Documentation You'd Like

The existing docs page should be updated to replace the undefined abi with the properly imported l2OutputOracleProxyABI. This change ensures that the example code runs correctly and interacts with the contract as intended. No new pages are required, only an update to the existing docs to correct the code.

Links to Related Pages

system-contracts.mdx

Additional Context

The issue arises because abi is not defined or imported, which causes a runtime error when trying to use it. I have already submitted a pull request to fix this by replacing abi with l2OutputOracleProxyABI, which was correctly imported. This update will prevent execution errors and ensure the docs provides accurate and functional example code for developers working with Optimism.

@huperts huperts added community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation labels Oct 19, 2024
@huperts huperts changed the title [DOCS] Add PR title [DOCS] Incorrect variable 'abi' in system contracts docs Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant