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.

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

make replace with count=0 a no-op #22325

Merged
merged 13 commits into from
Jul 4, 2017
Merged

make replace with count=0 a no-op #22325

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7688517
replace with count=0 is a no-op
rfourquet Jun 10, 2017
5b99e0a
document the behavior for negative count
rfourquet Jun 10, 2017
2f26043
remove default in the docstring
rfourquet Jun 10, 2017
d387b31
use typemax(Int) instead of -1 for unlimited (nalimilan)
rfourquet Jun 11, 2017
bd0079a
deprecate when count < 0 and add NEWS.md entry
rfourquet Jun 11, 2017
5d03ce1
avoid error when a number bigger than typemax(Int) is passed as count…
rfourquet Jun 11, 2017
06a8cfd
add another commented method to be uncommented when replace removed f…
rfourquet Jun 11, 2017
06a7706
check replace is implemented for GenericString (nalimilan)
rfourquet Jun 12, 2017
d77b51a
remove un-needed Base. prefix
rfourquet Jun 12, 2017
4f60ef7
add missing backtick (nalimilan)
rfourquet Jun 12, 2017
981e8da
remove unecessary `Base.` (tkelman) and cancel conversion to Int (nal…
rfourquet Jun 13, 2017
4405d63
improve TODO notes (StefanKarpinski)
rfourquet Jun 15, 2017
ff0b955
cross-ref search (tkelman)
rfourquet Jul 4, 2017
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
Prev Previous commit
Next Next commit
remove unecessary Base. (tkelman) and cancel conversion to Int (nal… 
…imilan)
  • Loading branch information
@rfourquet
rfourquet committed Jul 4, 2017
commit 981e8daba945fd0d4169c1320d723d25f4da9ed8
2 changes: 1 addition & 1 deletion base/deprecated.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1512,7 +1512,7 @@ function replace(s::AbstractString, pat, f, n::Integer)
:replace)
replace(s, pat, f)
else
Base.replace_new(String(s), pat, f, clamp(n, 0, typemax(Int)) % Int)
replace_new(String(s), pat, f, n)
end
end

Expand Down
4 changes: 2 additions & 2 deletions base/strings/util.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ _replace(io, repl, str, r, pattern) = print(io, repl)
_replace(io, repl::Function, str, r, pattern) =
print(io, repl(SubString(str, first(r), last(r))))

function replace_new(str::String, pattern, repl, count::Int)
function replace_new(str::String, pattern, repl, count::Integer)
# rename to `replace` when `replace` is removed from deprecated.jl
count == 0 && return str
count < 0 && throw(DomainError())
Expand Down Expand Up @@ -408,7 +408,7 @@ references in `r` are replaced with the corresponding matched text.
replace(s::AbstractString, pat, f) = replace_new(String(s), pat, f, typemax(Int))
# change this to the following when `replace` is removed from deprecated:
Copy link
Member

Choose a reason for hiding this comment

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

The problem with this kind of comment is that nobody is going to notice it when removing deprecation. I'd say let's go with ::Integer, and once the deprecation has been removed, feel free to open a PR to do this.

Copy link
Member

Choose a reason for hiding this comment

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

This hasn't been addressed.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh that's the second time since yesterday that my comment is not sent, with a "You can't perform this action at this time" message. My last unsent message was:

I added GenericString to the tests of replace, so if the deprecation is removed without taking this comment into account, the tests will fail. What I can also do is to open a PR to remove the deprecation right after we merge this.

IOW, the comments cannot be silently ignored and it would be wrong to ignore it even if there was not this conversion-to-Int change (and I can open the subsequent PR in advance for the next release), but I can update if you still prefer that I postpone this one.

Copy link
Member

Choose a reason for hiding this comment

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

Honestly I'd rather leave this out, but let's hear what others think about it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok I left it out.

Copy link
Member

Choose a reason for hiding this comment

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

I would put a TODO note in base/deprecated.jl referring to this and saying that it should be removed. That way there's a trail of breadcrumbs when doing the normal deprecations deletion.

Copy link
Member Author

Choose a reason for hiding this comment

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

There was already instructions in "base/deprecated.jl", but I updated to be even more clear.

# replace(s::AbstractString, pat, f, count::Integer=typemax(Int)) =
# replace(String(s), pat, f, clamp(count, typemin(Int), typemax(Int)) % Int)
# replace(String(s), pat, f, count)


# hex <-> bytes conversion
Expand Down