Repository navigation
FS perms and IO Tasks, Interrupts and more - #45
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the cookbook’s IO and filesystem documentation by splitting previously mixed topics into more focused recipes and adding new coverage for file permissions, task concurrency patterns, process spawning, sleeping, and interrupts.
Changes:
- Replaces older IO recipes with new dedicated pages for spawning tasks, running tasks in parallel, sleeping/async sleep, child processes, and interruption patterns.
- Adds a new filesystem recipe for setting/reading file permissions, and relocates some filesystem snippets (e.g., rename) to more appropriate pages.
- Updates chapter aggregation files (
Cookbook/IO.lean,Cookbook/FileSystem.lean) to reflect the new structure and removes obsolete example/config files.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| service_config.toml | Removes a previously committed sample TOML config file. |
| README.md | Updates the repository positioning/intro note. |
| Cookbook/IO/TasksAndConcurrency.lean | Deletes the old combined tasks/concurrency recipe. |
| Cookbook/IO/SpawningTasks.lean | Adds a new recipe covering Task spawning, status, and thread IDs. |
| Cookbook/IO/SpawningChildProcess.lean | Adds a new recipe for IO.Process.run/output/spawn and env vars. |
| Cookbook/IO/SleepingProcess.lean | Adds a new recipe explaining IO.sleep vs async sleep and .block. |
| Cookbook/IO/RunningTasksInParallel.lean | Adds a new recipe demonstrating concurrent IO tasks. |
| Cookbook/IO/ProcessInterrupt.lean | Adds a new recipe on interruptible sleep, promises, and idle waiting. |
| Cookbook/IO/Miscellaneous.lean | Expands miscellaneous IO content (process exit, compression, deadlocks). |
| Cookbook/IO/EnvironmentVars.lean | Removes the old environment variables recipe (content moved elsewhere). |
| Cookbook/IO.lean | Updates IO chapter imports/includes to the new recipe set/order. |
| Cookbook/Infoview/DisplayingInTheInfoView.lean | Small documentation/formatting edits to the Infoview recipe. |
| Cookbook/FileSystem/WritingToFile.lean | Adds file rename snippet to the writing-to-file recipe. |
| Cookbook/FileSystem/RunningAnExternalProgram.lean | Removes the old external program recipe (content moved to IO). |
| Cookbook/FileSystem/Miscellaneous.lean | Removes the rename snippet from filesystem miscellaneous. |
| Cookbook/FileSystem/FilePermissions.lean | Adds a new recipe for setting and reading file permissions. |
| Cookbook/FileSystem.lean | Updates filesystem chapter imports/includes (adds permissions recipe). |
| Cookbook/DataStructures/TOML/ReadWriteTomlFile.lean | Comments out the round-trip #eval example. |
| Cookbook/BuildingRecipe.lean | Updates documentation guidance around formatting/errors and html splitting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR refactors IO and FS a lot and improve the overall arrangement
things are much better.
Checklist
lake build lean-cookbook && lake exe lean-cookbookand checked how it looks locally.Any other remarks