Skip to content

Add missing documentation to String methods #8447

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
RX14 merged 10 commits into from
Apr 9, 2020
Merged

Add missing documentation to String methods #8447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4025c52
add missing documentation to String methods
jan-zajic Nov 9, 2019
4bfd993
change byte_slice(Int) ArgumentError->IndexError when out of range
jan-zajic Nov 9, 2019
352373b
add missing documentation to String methods #2
jan-zajic Nov 16, 2019
d18213f
byte_index doc typo
jan-zajic Nov 17, 2019
dd46819
change ditto to :ditto: in string doc
jan-zajic Nov 17, 2019
456ba9e
validate offset in String#byte_index(Int,offset) and make negative of…
jan-zajic Nov 21, 2019
0178859
Document String byte_slice risks
jan-zajic Nov 25, 2019
43a330b
#8447 requested changes
jan-zajic Jan 3, 2020
2620493
typo in byte_slice?, byte_at? doc
jan-zajic Jan 6, 2020
1d8df36
requested change of index/byte_index doc
jan-zajic Apr 9, 2020
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
17 changes: 17 additions & 0 deletions spec/std/string_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,15 @@ describe "String" do
it "gets byte_slice with negative index" do
"hello".byte_slice(-2, 3).should eq("lo")
end

it "gets byte_slice(Int) with start out of bounds" do
expect_raises(IndexError) do
"hello".byte_slice(10)
end
expect_raises(IndexError) do
"hello".byte_slice(-10)
end
end
end

describe "to_i" do
Expand Down Expand Up @@ -920,6 +929,14 @@ describe "String" do
it { "foo".byte_index('o'.ord).should eq(1) }
it { "foo bar booz".byte_index('o'.ord, 3).should eq(9) }
it { "foo".byte_index('a'.ord).should be_nil }
it { "foo".byte_index('a'.ord).should be_nil }
it { "foo".byte_index('o'.ord, 3).should be_nil }
it {
"Dizzy Miss Lizzy".byte_index('z'.ord).should eq(2)
"Dizzy Miss Lizzy".byte_index('z'.ord, 3).should eq(3)
"Dizzy Miss Lizzy".byte_index('z'.ord, -4).should eq(13)
"Dizzy Miss Lizzy".byte_index('z'.ord, -17).should be_nil
}

it "gets byte index of string" do
"hello world".byte_index("he").should eq(0)
Expand Down
Loading