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: Updates and Syntax Corrections #2396

Merged
merged 4 commits into from
Dec 6, 2024
Merged

docs: Updates and Syntax Corrections #2396

merged 4 commits into from
Dec 6, 2024

Conversation

donatik27
Copy link
Contributor

Changes Overview

1. README.md

  • Old: "will help you master Ape framework with tutorials and challenges."
  • New: "which will help you master Ape framework with tutorials and challenges."
  • Reason: Improved grammar and readability by adding "which" as a proper relative pronoun.

2. docs/userguides/compile.md

  • Old: vyper.compile(Path("path/to/contract.sol"))
  • New: solidity.compile(Path("path/to/contract.sol"))
  • Reason: Corrected the compiler reference from vyper to solidity since the file being compiled is a Solidity contract (.sol extension).

3. docs/userguides/scripts.md

  • Old: "will connect to your default network"
  • New: "will connect to your default network."
  • Reason: Added proper punctuation (period) at the end of the sentence for consistency in documentation.

Summary

These changes improve documentation clarity, fix a technical inaccuracy in the compiler reference, and maintain consistent punctuation throughout the documentation. The updates make the documentation more professional and accurate for users of the Ape framework.

@antazoey antazoey changed the title Documentation Updates and Syntax Corrections docs: Updates and Syntax Corrections Dec 5, 2024
@antazoey antazoey enabled auto-merge (squash) December 6, 2024 16:52
@antazoey antazoey merged commit c23ace0 into ApeWorX:main Dec 6, 2024
18 checks passed
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