docs: jsdoc return statement update

[DhairyaMajmudar]

Description

Updating return statements of functions generateFromString, generateFromURL and generateFromFile by adding type TemplateRenderResult | undefined

Related issue(s)

Fixes: #507

Screenshot of markdown rendered on website:

Before	After

cc: @derberg @ItshMoh

[changeset-bot]

⚠️ No Changeset found

Latest commit: edcd1fc

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

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[derberg]

that was fast

can you specify why you didn't add these https://github.com/asyncapi/generator/pull/967/files#diff-ccc178369ef3ad89acc2592970d94838d2dc83c38731610f3675be2ee3e6f99aR216-R226. How can I learn from JSDoc the structure of TemplateRenderResult if this is not provided? or maybe should the type be imported from react sdk dependency?

[DhairyaMajmudar]

that was fast

Hehe Thank you : )

can you specify why you didn't add these https://github.com/asyncapi/generator/pull/967/files#diff-ccc178369ef3ad89acc2592970d94838d2dc83c38731610f3675be2ee3e6f99aR216-R226. How can I learn from JSDoc the structure of TemplateRenderResult if this is not provided? or maybe should the type be imported from react sdk dependency?

We don't need to import or declare the type TemplateRenderResult within JSdocs just like it is done in previous PR. I've learnt about that from this line example

generator/apps/generator/lib/generator.js

Line 926 in 59504bc

* @return {Promise<string|TemplateRenderResult|Array<TemplateRenderResult>|undefined>}

[derberg]

lgtm, thanks!

I changed PR title, as fix indicates release and we do not need to release new artefact for this one. Anyway fix: is not enough if changeset is not provided

[derberg]

/rtm

[DhairyaMajmudar]

lgtm, thanks!

I changed PR title, as fix indicates release and we do not need to release new artefact for this one. Anyway fix: is not enough if changeset is not provided

No, worries Thank you for your approval. I'll open a PR for updating website with repo too.

[derberg]

this part is automated: asyncapi/website#3573

[DhairyaMajmudar]

this part is automated: asyncapi/website#3573

Fantastic 🔥