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

feat(cheatcodes): add docs for exists, isFile and isDir cheats #993

Merged
merged 4 commits into from
Aug 30, 2023

Conversation

ruvaag
Copy link
Contributor

@ruvaag ruvaag commented Aug 29, 2023

Add docs for new filesystem cheatcodes exists, isFile and isDir from foundry-rs/foundry#5719

  • Update src/cheatcodes/fs.md with cheatcode sigs
  • Update src/cheatcodes/README.md with cheatcode sigs

Copy link
Member

@Evalir Evalir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet, this so far lgtm. We also need a page for each cheatcode explaining what they do like https://github.com/foundry-rs/book/blob/master/src/cheatcodes/chain-id.md

@ruvaag
Copy link
Contributor Author

ruvaag commented Aug 29, 2023

Got it, thanks. Looks like the filesystem cheatcodes are grouped under src/cheatcodes/fs.md for now.

Would it be better to append an example block for exists, isFile and isDir on the same page to keep them grouped? If not, I can create separate pages for the three of these instead.

@Evalir
Copy link
Member

Evalir commented Aug 29, 2023

gotcha! yep, let's group them up on fs.md

@ruvaag ruvaag requested a review from Evalir August 30, 2023 21:01
@Evalir Evalir merged commit 45d357c into foundry-rs:master Aug 30, 2023
1 check passed
@ruvaag ruvaag deleted the fs-cheat-docs branch August 30, 2023 22:09
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