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

mv: rename remove_destination keyword to force #25979

Closed
StefanKarpinski opened this issue Feb 9, 2018 · 4 comments
Closed

mv: rename remove_destination keyword to force #25979

StefanKarpinski opened this issue Feb 9, 2018 · 4 comments
Labels
good first issue Indicates a good issue for first-time contributors to Julia help wanted Indicates that a maintainer wants help on an issue or pull request
Milestone

Comments

@StefanKarpinski
Copy link
Member

I can never remember this keyword name. It's way too long and this kind of option is almost always called force in UNIX commands, which is what we model our file system API on.

@StefanKarpinski StefanKarpinski added triage This should be discussed on a triage call help wanted Indicates that a maintainer wants help on an issue or pull request good first issue Indicates a good issue for first-time contributors to Julia labels Feb 9, 2018
@StefanKarpinski StefanKarpinski changed the title rename mv(; remove_destination=false) to mv(; force=false) mv: rename remove_destination keyword to force Feb 9, 2018
@StefanKarpinski
Copy link
Member Author

While we're at this, we may want to look at other file API functions and make sure they have consistent keyword names. I.e. force and recursive.

@JeffBezanson
Copy link
Member

cp also has this argument.

@ranjan-sh
Copy link

I would like to work on this, if it's alright with everyone.
I am new to the community,so where and how should I start?

@StefanKarpinski
Copy link
Member Author

Hi, @turing93. Thanks for the help! First check out

https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md

Keep the advice there in mind. For this particular change, you'll want to add the force keyword and keep the old remove_destination keyword but change its default to nothing. If any value is supplied for remove_destination print a deprecation warning (there are various places in the code base that do this, so find one and do something similar) and overwrite the default value of force with it. Then change all usages of the functions that you update (mv and cp). After that run make testall and check that all the tests pass. Beware that this can take a long while and use a lot of CPU. You may want to get on the Julia Slack and ask questions in the #my-first-pr channel on there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Indicates a good issue for first-time contributors to Julia help wanted Indicates that a maintainer wants help on an issue or pull request
Projects
None yet
Development

No branches or pull requests

3 participants