[NFC] Add more comments

[Drvi]

No description provided.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e1bfb0c) 90.78% compared to head (e9327b9) 90.78%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #8   +/-   ##
=======================================
  Coverage   90.78%   90.78%           
=======================================
  Files           1        1           
  Lines         228      228           
=======================================
  Hits          207      207           
  Misses         21       21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nickrobinson251]

Looks great from what i've reviewed so far

i want to try to understand the details of the algorithms a bit better with the help of the new examples

[nickrobinson251]

it would be idiomatic for the argument being mutated out to be the first argument.

Is there a reason to break from that idiom?

Can we open an issue to change to that, so we have

find_newlines!(out::AbstractVector{Int32}, l::Lexer, buf::Vector{UInt8}, curr_pos::Int=firstindex(buf), end_pos::Int=lastindex(buf))

?

[Drvi]

I think you are right, but it does feel weird to me that the thing that impacts the implementation the most and that also gets mutated internally comes second... In an OO language, this would be Lexer.find_newlines(...), I think this is what throws me off.