Objective

I experienced an issue where HashMap::new was not returning a value typed appropriately for a HashMap<K,V> declaration that omitted the Hasher- e.g. the Default Hasher for the type is different than what the new method produces.

After discussion on discord, this appears to be an issue in hashbrown, and working around it would be very nontrivial, requiring a newtype on top of the hashbrown implementation. Rather than doing that, it was suggested that we add docs to make the issue more visible and provide a clear workaround.

Solution

Updated the docs for bevy_platform_support::collections. I couldn't update Struct docs because they're re-exports, so I had to settle for the module.

Note that the [HashMap::new] link wasn't generating properly- I'm not sure why. I see the method in the docs.rs site, https://docs.rs/hashbrown/0.15.1/hashbrown/struct.HashMap.html#method.new, but not on the generated internal documentation. I wonder if hashbrown isn't actually implementing the new or something?

Testing

n/a although I did generate and open the docs on my Ubuntu machine.

Showcase

before:

after: