Supplement Documentation for pop() Function

[dohyun-ko]

Description

The current documentation for the pop() function does not fully explain its functionality. While it mentions additional options as the first parameter, the implementation shows that the first parameter can also be a number specifying the number of stacks to pop. This PR updates the documentation to accurately reflect the function’s behavior.

---

Changes Made

1. Clarified the pop() function’s parameters:
   • Added details about the count parameter for specifying the number of stacks to pop.
   • Explained the dual usage of the first parameter (as a number or options object).
2. Updated code examples to demonstrate:
   • Popping multiple stacks.
   • Combining count and options parameters.
3. Enhanced the parameter table with default values and examples.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 643d4cc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
stackflow-docs	✅ Ready (Inspect)	Visit Preview	Dec 14, 2024 11:05am