Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007868OCamldocumentationpublic2018-10-26 11:172018-10-26 16:00
Reporterskaller 
Assigned Togasche 
PrioritynormalSeverityminorReproducibilityN/A
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version4.07.1 
Target VersionFixed in Version4.08.0+dev 
Summary0007868: Set.diff not documented properly
DescriptionThe docs say Set.diff is "set difference".

As I pointed out years ago (why isn't this fixed!!) there are TWO operations called set difference. Both should be provided IMHO but at least the one that is provided should be properly specified.

Is this (a) the symmetric difference, equal to the union with the intersection removed, OR is it (b) the asymmetric difference, the elements of the first set with those of the second which are in it removed?
Steps To ReproduceJust read the docs.
TagsNo tags attached.
Attached Files

- Relationships

-  Notes
(0019426)
nojebar (developer)
2018-10-26 11:27

It is the second type ("asymmetric"). It hasn't been fixed because nobody has had the time or inclination to do it until now.

Would you like to propose a patch for the docs? You can even do it directly via github's interface, no need to make a branch, etc.
(0019427)
frisch (developer)
2018-10-26 11:28

I think that the "set difference" terminology is much more common than "asymmetric difference" (people referring to the "symmetric difference" always mention "symmetric" explicitly), and so there should be no risk of confusion. But I wouldn't be opposed to make things more explicit, if you or someone else want to propose a PR to improve the documentation.
(0019428)
gasche (administrator)
2018-10-26 12:19

I hadn't seen the comments (just the first report in my mailbox) so I proposed a PR:

  https://github.com/ocaml/ocaml/pull/2119 [^]
(0019429)
skaller (reporter)
2018-10-26 16:00

Thanks!

- Issue History
Date Modified Username Field Change
2018-10-26 11:17 skaller New Issue
2018-10-26 11:27 nojebar Note Added: 0019426
2018-10-26 11:28 frisch Note Added: 0019427
2018-10-26 11:29 frisch Assigned To => frisch
2018-10-26 11:29 frisch Status new => acknowledged
2018-10-26 12:19 gasche Note Added: 0019428
2018-10-26 15:30 frisch Status acknowledged => resolved
2018-10-26 15:30 frisch Fixed in Version => 4.08.0+dev
2018-10-26 15:30 frisch Resolution open => fixed
2018-10-26 15:30 frisch Assigned To frisch => gasche
2018-10-26 16:00 skaller Note Added: 0019429


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker