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

Incomplete jsdoc in fragment.js::loadFragment #44

Open
flx-sta opened this issue Feb 2, 2024 · 0 comments · May be fixed by #61
Open

Incomplete jsdoc in fragment.js::loadFragment #44

flx-sta opened this issue Feb 2, 2024 · 0 comments · May be fixed by #61

Comments

@flx-sta
Copy link

flx-sta commented Feb 2, 2024

Expected Behaviour

/**
 * Loads a fragment.
 * @param {string} path The path to the fragment
 * @returns {Promise<HTMLElement>} The root element of the fragment. <--- Promise!
 */
export async function loadFragment(path) {
  //...
}

Actual Behaviour

/**
 * Loads a fragment.
 * @param {string} path The path to the fragment
 * @returns {HTMLElement} The root element of the fragment.
 */
export async function loadFragment(path) {
  //...
}

Reproduce Scenario (including but not limited to)

Steps to Reproduce

Platform and Version

Sample Code that illustrates the problem

https://github.com/adobe/aem-block-collection/blob/main/blocks/fragment/fragment.js#L18

Logs taken while reproducing problem

@shsteimer shsteimer linked a pull request Apr 29, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant