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

Fix typo in code example Update README.md #753

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mdqst
Copy link

@mdqst mdqst commented Nov 21, 2024

Description:
This pull request addresses a minor but important issue in the code example provided in the "Formatting old JSON assembly output" section.

Снимок экрана 2024-11-21 в 12 41 05

Issue:

The following line in the documentation has a missing semicolon at the end:

var translate = require('solc/translate')  

Fix:

The corrected version adds the missing semicolon to align with JavaScript coding standards:

var translate = require('solc/translate');  

Importance:

While this is a small typo, maintaining proper syntax in code examples is critical for:

  1. Readability: Adhering to standard coding practices makes the code easier to understand for readers.
  2. Compatibility: Ensuring proper syntax prevents potential issues when the code is copied into stricter environments or linted using standard tools.

Thank you for reviewing this PR. I believe this fix contributes to maintaining high-quality documentation and a professional standard for users.

Fix typo in code example: missing semicolon in JSON assembly output formatting
@coveralls
Copy link

Coverage Status

coverage: 84.537%. remained the same
when pulling 2d1bd04 on mdqst:patch-1
into 4aec1e7 on ethereum:master.

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.

2 participants