Documentation issues in Data.Vector.Mutable

[treeowl]

MVector is exported concretely, but its three fields are undocumented. In particular, it's not obvious to users whether the second Int is an offset or a length.

slice doesn't document what its Int arguments mean. Data.Vector.Generic.basicUnsafeSlice lacks that documentation as well. The explanation should be copied from Data.Vector in each case.

init, tail, take, drop, and splitAt have no documentation whatsoever, and in particular fail to note that they don't copy the underlying vector. The "unsafe" versions are also completely undocumented.

unsafeNew claims that the vector isn't initialized, but it actually is. Only unboxed vectors can be created uninitialized. The only difference between unsafeNew and new is that new checks that the requested size is sensible.

[sjakobi]

Thanks for the hint regarding slice! I had hoped that I could find info on this on the issue tracker! :)

[cartazio]

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> .