FSharp.Core. summary XML documentation for pairwise (List, Array, and Seq) is misleading #17052
Labels
Area-Documentation
Bug
Impact-Low
(Internal MS Team use only) Describes an issue with limited impact on existing code.
Milestone
The summary xml documentation for
List.pairwise
does not explicitly specify the order of the paired elements in the output list, and implies an incorrect order.From IDE "go to definition" on
List.pairwise
in a F# project under using FSharp.Core 8.0.200:** Suggested change **
Versions
(I think this has been constant forever and is not version dependent)
Related information
The example in the documentation is correct. However when programming the summary XML documentation is more important because easily available through IDEs. This is a function where the order of the elements in the returned pair is not obvious and will not be easily remembered - so accurate summary documentation is especially helpful.
The text was updated successfully, but these errors were encountered: