styled-components / styled-components-website

The styled-components website and documentation
https://styled-components.com
MIT License
611 stars 437 forks source link

Inaccurate `shouldForwardProp` description #966

Open Tbhesswebber opened 3 months ago

Tbhesswebber commented 3 months ago

According to the docs, shouldForwardProp takes an optional second parameter that is the default validator function. However, according to the implementation, the second argument is the component or element itself.

I'm happy to submit a PR to fix this, but I wanted to verify that there isn't some kind of rationale behind the current deviation first.