docs(menu): clarity in animated param

soundproofboot · brandyscarney · web-flow · commit 406b8049629e · 2025-06-23T16:36:28.000-05:00
Co-authored-by: Brandy Smith &lt;brandyscarney@users.noreply.github.com&gt;
diff --git a/core/src/components/menu/menu.tsx b/core/src/components/menu/menu.tsx
@@ -378,7 +378,7 @@ export class Menu implements ComponentInterface, MenuI {
    * Closes the menu. If the menu is already closed or it can't be closed,
    * it returns `false`.
    * 
-   * @param animated If `true`, close the menu with animation. Defaults to `true`.
+   * @param animated If `true`, the menu will animate when closing. If `false`, the menu will close instantly without animation. Defaults to `true`.
    * @param role The role of the element that is closing the menu.
    * This can be useful in a button handler for determining which button was
    * clicked to close the menu. Some examples include:

Original file line number	Diff line number	Diff line change
`@@ -378,7 +378,7 @@ export class Menu implements ComponentInterface, MenuI {`
`378`	`378`	`* Closes the menu. If the menu is already closed or it can't be closed,`
`379`	`379`	* it returns `false`.
`380`	`380`	`*`
`381`		- * @param animated If `true`, close the menu with animation. Defaults to `true`.
	`381`	+ * @param animated If `true`, the menu will animate when closing. If `false`, the menu will close instantly without animation. Defaults to `true`.
`382`	`382`	`* @param role The role of the element that is closing the menu.`
`383`	`383`	`* This can be useful in a button handler for determining which button was`
`384`	`384`	`* clicked to close the menu. Some examples include:`