Sitelet https://github.com/foundry-rs/compilers/pull/226
Skip to content
This repository was archived by the owner on Apr 20, 2026. It is now read-only.

Fix minor grammatical issue in project documentation - #226

Merged
mattsse merged 1 commit into
foundry-rs:mainfrom
voronor:patch-1
Nov 22, 2024
Merged

mattsse merged 1 commit into
foundry-rs:mainfrom
voronor:patch-1

Conversation

@voronor

@voronor voronor commented Nov 22, 2024

Copy link
Copy Markdown
Contributor

Description:

This pull request addresses a minor grammatical issue in the project documentation regarding the description of the dependency resolution algorithm. Specifically, the following sentence:

Finding all dependencies is fairly simple, we're simply doing a DFS, starting the source contracts.

Issue:

The sentence is missing the preposition "from," making it grammatically incorrect and slightly harder to read. The corrected version is:

Finding all dependencies is fairly simple, we're simply doing a DFS, starting from the source contracts.

Importance:

While this is a small change, improving the grammar enhances the readability and professionalism of the documentation. Clear documentation is especially important for developers who rely on it to understand the dependency resolution logic and its implementation.

Change Summary:

  • Added the preposition "from" to the sentence describing the DFS algorithm for finding dependencies.

Before:

Finding all dependencies is fairly simple, we're simply doing a DFS, starting the source contracts.

After:

Finding all dependencies is fairly simple, we're simply doing a DFS, starting from the source contracts.


Thank you for maintaining this great project! Please let me know if additional changes are required. 😊

This pull request addresses a minor grammatical issue in the project documentation regarding the description of the dependency resolution algorithm.
@mattsse
mattsse merged commit 9e55c52 into foundry-rs:main Nov 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants