Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add @fire and @event documentation for EnableNewProductSyncButton #2554

Open
puntope opened this issue Aug 22, 2024 · 0 comments
Open

Add @fire and @event documentation for EnableNewProductSyncButton #2554

puntope opened this issue Aug 22, 2024 · 0 comments
Labels
type: enhancement The issue is a request for an enhancement.

Comments

@puntope
Copy link
Contributor

puntope commented Aug 22, 2024

We missed adding the JSDOCS for the event in EnableNewProductSyncButton

It should be something like:

/**
 * @event  gla_enable_product_sync_click
 * 
 * @property {string} context Indicates where this event happened
 */

and

/**
 * @fires gla_enable_product_sync_click with `{ context: "banner"}`
 */
  • Check also more places where events are not being documented.

Is your feature request related to a problem?

Lack of documentation for the added events.

How to reproduce the problem

Doc-related problem. Not reproducible in the plugin.

Describe the solution you'd like

Documentation for the added events as explained before.

@puntope puntope added the type: enhancement The issue is a request for an enhancement. label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement The issue is a request for an enhancement.
Projects
None yet
Development

No branches or pull requests

1 participant