Unclear documentation for remove_if

[anlumo]

The documentation for DashMap::remove_if says

Removes an entry from the map, returning the key and value if the entry existed and the provided conditional function returned true.

This could be interpreted in two ways:

• Removes an entry from the map, (returning the key and value if the entry existed and the provided conditional function returned true).
• (Removes an entry from the map, returning the key and value) if the entry existed and the provided conditional function returned true.

Reading the code:

dashmap/src/lib.rs

Lines 991 to 996 in f2d248e

	if f(k, v.get()) {
	let ((k, v), _) = unsafe { shard.remove(bucket) };
	Some((k, v.into_inner()))
	} else {
	None
	}

it's clear that the latter is the approach actually implemented, but it shouldn't be necessary to look into the code for this.