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.

Sign up for GitHub

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

Jump to bottom

How to document methods and method arguments? #47

Closed
CetinSert opened this issue Nov 4, 2020 · 6 comments · Fixed by #147
Closed

How to document methods and method arguments? #47

CetinSert opened this issue Nov 4, 2020 · 6 comments · Fixed by #147
Assignees
@web-padawan
Labels
enhancement New feature or request

Comments

@CetinSert
Copy link

Is there a way to document methods and their arguments in a consistent fashion?
@web-padawan
Copy link
Collaborator

Thanks for the issue. This needs runem/web-component-analyzer#146 to be implemented.

@CetinSert
Copy link
Author

Actually, in my workflow, I manually edit the custom-elements.json file, completely by passing the need for the analyzer.

@web-padawan web-padawan added the enhancement New feature or request label Nov 2, 2021
@web-padawan
Copy link
Collaborator

Depends on #61

@Dav1dde
Copy link

Dav1dde commented Jan 26, 2022

#61 seems to be done, has there been any progress on it? It seems like 1.0.0-pre.3 does not display methods.

@web-padawan
Copy link
Collaborator

Yes the support for methods isn't added yet. I will work on this when I have time, hopefully this Friday.

@web-padawan web-padawan self-assigned this Jan 26, 2022
This was referenced Jan 28, 2022
Merged
Merged
@rpsirois
Copy link

rpsirois commented May 20, 2022 •
edited
Loading

@web-padawan thanks for taking care of this issue. I noticed there was no information in the changelog and the CDNs are still at

  • unpkg: 1.0.0-pre.3
  • skypack: 1.0.0-pre.3
  • jspm: 1.0.0-pre.2

Is there a targeted version for this release or do I need to build from source? Thank you for your work on this library.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@web-padawan web-padawan

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: show method params and return type open-wc/api-viewer-element
4 participants
@CetinSert @Dav1dde @rpsirois @web-padawan