docs: point alias docs to canonical function

[Antoliny0919]

Summary

The documentation for aliased functions is currently quite inconsistent. It would be better if both documents used the same description rather than providing different explanations.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
es-toolkit	Ready	Preview, Comment	Jul 10, 2026 6:57am

[Antoliny0919]

I'm planning to consolidate the documentation for functions that have aliases.

You can find the reasoning behind this in the comment below.

I've put together one example of what the consolidated documentation would look like. Would you be willing to help with the remaining alias functions once we agree on the approach?

Functions that require documentation consolidation

• each, forEach
• eachRight, forEachRight
• first, head
• extend, assignIn
• extendWith, assignInWith
• entries, toPairs
• entriesIn, toPairsIn

(Just as a side note, it looks like entries and entriesIn aren't implemented yet 🥲)

[Antoliny0919]

I removed the detailed documentation from the aliased function.

Using each and forEach as an example, they provide the same functionality, so I think their documentation should remain consistent as well. If both documents contain detailed explanations, any future changes will need to be made in both places.

If one of them is updated without the other being reviewed, we could easily end up in a situation where two aliases provide different documentation for the same behavior.

For that reason, I removed the detailed description from each and had it refer to the forEach documentation instead.

Previously, both functions had detailed documentation. Was there a particular reason for that?

[Antoliny0919]

noticed that the types documented in each were written correctly, so I applied that to forEach. Going forward, when consolidating docs for other aliases beyond each <-> forEach, what do you think about just taking whichever version is more accurate between the two and consolidating them into one, rather than keeping both?

[Antoliny0919]

I also added an Alias section to the forEach documentation to make it clear that each is an alias of forEach.
(Lodash includes a similar section, which I think helps with discoverability as well.)

I'm not sure whether this is the best place for the section. If you think there's a more appropriate location, please let me know!