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 errors in documentation files #281

Merged
merged 4 commits into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ solc src/pages/hello-world/HelloWorld.sol
find src/pages/hacks -name "*.sol" solc {} \;
find src/pages -type f -name "*.sol" -exec sh -c 'solc "$0"' {} \;

## Mics ##
## Misc ##
# rename files
find . -type f -name "index.test.js" -exec sh -c 'mv "$0" "${0%.test.js}.test.tsx"' {} \;
```
2 changes: 1 addition & 1 deletion src/pages/call/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cyfrinLink: https://www.cyfrin.io/glossary/call-code-example

This is the recommended method to use when you're just sending Ether via calling the `fallback` function.

However it is not the recommend way to call existing functions.
However it is not the recommended way to call existing functions.

### Few reasons why low-level call is not recommended

Expand Down
4 changes: 2 additions & 2 deletions src/pages/defi/vault/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Most vaults on the mainnet are more complex. Here we will focus on the math for

### How the contract works

1. Some amount of shares are minted when an user deposits.
1. Some amount of shares are minted when a user deposits.
2. The DeFi protocol would use the users' deposits to generate yield (somehow).
3. User burn shares to withdraw his tokens + yield.
3. User burns shares to withdraw his tokens + yield.

```solidity
{{{Vault}}}
Expand Down
2 changes: 1 addition & 1 deletion src/pages/hashing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cyfrinLink: https://www.cyfrin.io/glossary/hashing-with-keccak256-code-example

Some use cases are:

- Creating a deterministic unique ID from a input
- Creating a deterministic unique ID from an input
- Commit-Reveal scheme
- Compact cryptographic signature (by signing the hash instead of a larger input)

Expand Down