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

rm: make the utility public #5304

Merged
merged 4 commits into from
Sep 23, 2023
Merged

rm: make the utility public #5304

merged 4 commits into from
Sep 23, 2023

Conversation

KAAtheWiseGit
Copy link
Contributor

@KAAtheWiseGit KAAtheWiseGit commented Sep 22, 2023

Made Options, InteractiveMode, and the remove function public and added documentation for them. This is an attempt at implementing #5294.

rm options are much simpler compared to cp, so I just made them public. I am unsure if OPT_* constants should be made public too.

Additionally, I couldn't figure out what InteractiveMode::PromptProtected does, as it doesn't seem to be used anywhere. So the documentation is a TODO for now.

P.S. the commit also includes a minor typo fix: eay -> way.

@cakebaker cakebaker changed the title cp: make option types public rm: make option types public Sep 22, 2023
@KAAtheWiseGit
Copy link
Contributor Author

Amended the commit and overwrote the source branch to fix the copy paste error. Commit name should be correct now.

@KAAtheWiseGit
Copy link
Contributor Author

clippy and fmt did not raise any issues on my local machine.

Made `Options` and `InteractiveMode` public and added documentation for them.
@KAAtheWiseGit KAAtheWiseGit changed the title rm: make option types public rm: make the utility public Sep 22, 2023
Copy link
Member

@tertsdiepraam tertsdiepraam left a comment

Choose a reason for hiding this comment

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

Great! I've tried to explain what PromptProtected is below. It'd be great if you could add that as well. The rest of the docs look very nice!

src/uu/rm/src/rm.rs Outdated Show resolved Hide resolved
@sylvestre sylvestre merged commit e2e42ac into uutils:main Sep 23, 2023
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants