Skip to content

Docs - Trying to improve jsdoc for lizmap-features-table #5665

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Gustry
Copy link
Member

@Gustry Gustry commented Apr 28, 2025

@mdouchin Due to . in events name, this was not rendered in JSDoc.

Renaming these events, it makes the doc online working well :

image

I wonder if some alias can be added to avoid a API breaking change ?
Keen to have some feedbacks. I can add a note in CHANGELOG.md, but this will be a little notice. I wish could avoid renaming.

According to feedbacks from @vlebert #4502

@Gustry Gustry added doc-needed javascript Pull requests that update Javascript code backport release_3_9 labels Apr 28, 2025
@Gustry Gustry requested review from rldhont and mdouchin April 28, 2025 16:02
@github-actions github-actions bot added this to the 3.10.0 milestone Apr 28, 2025
@mdouchin
Copy link
Collaborator

Good catch ! Perhaps we could trigger old and new events to keep backward compatibility (for a while) ?

@Gustry
Copy link
Member Author

Gustry commented Apr 29, 2025

Good catch ! Perhaps we could trigger old and new events to keep backward compatibility (for a while) ?

Indeed, no need for an alias, I just triggering signals twice. So I have added backport to 3.8.

@rldhont
Copy link
Collaborator

rldhont commented Apr 29, 2025

All the new events have . in state module.

@Gustry
Copy link
Member Author

Gustry commented Apr 29, 2025

This PR needs a rebase. I made #5677 to be able review better the first part.

All the new events have . in state module.

Do they appear in https://docs.3liz.org/lizmap-web-client/js/ ?

With this PR, I notice there is a kind of namespace for JSDoc, which needs to be fixed.

@Gustry
Copy link
Member Author

Gustry commented Apr 29, 2025

See the doc now : https://docs.3liz.org/lizmap-web-client/js/module-FeaturesTable.html about lizmap-features-table

@rldhont
Copy link
Collaborator

rldhont commented Apr 30, 2025

I am not in favor is this event naming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants