Repository navigation
Documentation issues in Data.Vector.Mutable #213
Description
Activity
Thanks for the hint regarding
slice! I had hoped that I could find info on this on the issue tracker! :)- Thanks for tickling this ticket. These definitely should be improved. !…On Sat, Nov 30, 2019 at 7:19 PM Simon Jakobi ***@***.***> wrote: Thanks for the hint regarding slice! I had hoped that I could find info on this on the issue tracker! :) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#213?email_source=notifications&email_token=AAABBQRWO4ZQU4WNJFGOWFDQWL7JXA5CNFSM4E73DLQKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFQWZFQ#issuecomment-560032918>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAABBQUCIEZACMB6JDMBJHTQWL7JXANCNFSM4E73DLQA> .
- added 2 commits that reference this issue
on Feb 2, 2020 - added 2 commits that reference this issue
on Apr 11, 2020 - added 2 commits that reference this issue
on Jun 7, 2020 - added 2 commits that reference this issue
on Jan 16, 2021
MVectoris exported concretely, but its three fields are undocumented. In particular, it's not obvious to users whether the secondIntis an offset or a length.slicedoesn't document what itsIntarguments mean.Data.Vector.Generic.basicUnsafeSlicelacks that documentation as well. The explanation should be copied fromData.Vectorin each case.init,tail,take,drop, andsplitAthave no documentation whatsoever, and in particular fail to note that they don't copy the underlying vector. The "unsafe" versions are also completely undocumented.unsafeNewclaims that the vector isn't initialized, but it actually is. Only unboxed vectors can be created uninitialized. The only difference betweenunsafeNewandnewis thatnewchecks that the requested size is sensible.