Skip to content

chore(docs): auto-generate docs #25

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.

Sign up for GitHub

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

Merged
haithium merged 1 commit into from
Mar 23, 2026
Merged

chore(docs): auto-generate docs #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions docs/src/modules/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,9 @@ Rename or move a filesystem entry.
fs.rename("old.txt", "new.txt")
```

> [!NOTE] This is an alias for `os.rename`.
> [!NOTE]
>
> This is an alias for `os.rename`.

<a id="fn-rm"></a>

Expand Down Expand Up @@ -508,7 +510,9 @@ Return `true` when a path exists.
fs.exists("README.md") --> true
```

> [!NOTE] Broken symlinks return `false`.
> [!NOTE]
>
> Broken symlinks return `false`.

<a id="fn-lexists"></a>

Expand All @@ -530,4 +534,6 @@ Return `true` when a path exists without following symlinks.
fs.lexists("README.md") --> true
```

> [!NOTE] Broken symlinks return `true`.
> [!NOTE]
>
> Broken symlinks return `true`.