[core] Add a comment to explain useEnhancedEffect

[Janpot]

See mui/toolpad#2671 (comment)

also, consider renaming this hook to something more descriptive. e.g. I've seen other libraries use useIsomorphicLayoutEffect.

[mui-bot]

Netlify deploy preview

https://deploy-preview-39035--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 7f7b2b9

[oliviertassinari]

It's being redefined in some of the docs examples, e.g.

material-ui/docs/data/joy/customization/theme-colors/RemoveActiveTokens.js

Line 26 in 135d00a

const useEnhancedEffect =

. Perhaps this should also import the @mui/utils one? (The usage here seems a bit funky as well)

@Janpot @mui/utils is private today, we can't use it in the demos: https://www.notion.so/mui-org/mui-utils-purpose-9a9fc9da3a004864b6c4e1f4d1f24f95.

also, consider renaming this hook to something more descriptive. e.g. I've seen other libraries use useIsomorphicLayoutEffect.

This makes sense to me though not easy to change. To keep in sync with

material-ui/.eslintrc.js

Line 123 in 89635d1

'react-hooks/exhaustive-deps': ['error', { additionalHooks: 'useEnhancedEffect' }],