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: minor grammar & style fixes #2558

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

Hopium21
Copy link

  1. File: docs/userguides/contracts.md
    Old: avoid having to invoking Python directly

New: avoid having to invoke Python directly

Reason: "invoking" is a gerund; after "having to", the correct verb form is the infinitive "invoke". This fixes a grammatical inconsistency.

  1. File: docs/userguides/dependencies.md
    Old: Oftentimes, the \v prefix is required...

New: Oftentimes, the 'v' prefix is required...

Reason: The backticks were unnecessary and inconsistent with surrounding text. Switching to single quotes improves formatting clarity.

Old: ...more adhoc

New: ...more ad hoc

Reason: "Ad hoc" is a Latin phrase and should be written as two separate words. This improves accuracy and professionalism in writing.

  1. File: docs/userguides/proxy.md
    Old: vyper <0.2.9 create_forwarder_to

New: vyper <0.2.9 create_forwarder_to()

Reason: The create_forwarder_to is a function. Adding parentheses () correctly reflects its nature as a callable, improving clarity and consistency.

@fubuloubu fubuloubu changed the title Minor Grammar & Style Fixes docs: minor grammar & style fixes Mar 26, 2025
@fubuloubu fubuloubu enabled auto-merge (squash) March 26, 2025 14:16
@Hopium21 Hopium21 requested a review from fubuloubu March 31, 2025 13:34
fubuloubu
fubuloubu previously approved these changes Mar 31, 2025
auto-merge was automatically disabled March 31, 2025 14:53

Head branch was pushed to by a user without write access

@Hopium21 Hopium21 requested a review from fubuloubu March 31, 2025 14:54
@Hopium21 Hopium21 requested a review from fubuloubu March 31, 2025 15:33
@fubuloubu fubuloubu enabled auto-merge (squash) March 31, 2025 17:49
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