Skip to content

Improvement of documentation of function File.rm_rf! #14526

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

Jump to bottom
Closed
RaymondLoranger opened this issue May 23, 2025 · 1 comment
Closed

Improvement of documentation of function File.rm_rf! #14526

RaymondLoranger opened this issue May 23, 2025 · 1 comment

Comments

@RaymondLoranger
Copy link

Elixir and Erlang/OTP versions

The documentation is not a correct sentence.

Operating system

N/A

Current behavior

Same as rm_rf/1 but raises a File.Error exception in case of failures, otherwise the list of files or directories removed.

Expected behavior

Same as rm_rf/1 but raises a File.Error exception in case of failures, otherwise returns the list of files or directories removed.
@josevalim
Copy link
Member

Going to be fixed in #14528. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@josevalim @RaymondLoranger