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

Add support for variadic parameters in jsii-docgen #3781

Closed
garysassano opened this issue Aug 10, 2023 · 1 comment · Fixed by #4007
Closed

Add support for variadic parameters in jsii-docgen #3781

garysassano opened this issue Aug 10, 2023 · 1 comment · Fixed by #4007
Assignees
@tsuf239
Labels
🐛 bug Something isn't working 📚 documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@garysassano
Copy link
Collaborator

garysassano commented Aug 10, 2023 •
edited
Loading

I tried this:

Updated cloud.Queue.push() method to use a variadic parameter:

push(...messages: string[]): Promise<void>;

This happened:

The following documentation was generated:

inflight push(messages: str): void

I expected this:

I expected jsii-docgen to generate the following documentation instead:

inflight push(...messages: Array<str>): void

Is there a workaround?

No response

Component

Documentation

Wing Version

No response

Node.js Version

No response

Platform(s)

No response

Anything else?

No response

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
@garysassano garysassano added the 🐛 bug Something isn't working label Aug 10, 2023
@garysassano garysassano mentioned this issue Aug 10, 2023
Merged
@Chriscbr Chriscbr added 📚 documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 10, 2023
@staycoolcall911 staycoolcall911 mentioned this issue Aug 18, 2023
Closed
@tsuf239 tsuf239 self-assigned this Aug 29, 2023
@tsuf239 tsuf239 mentioned this issue Aug 29, 2023
Merged
5 tasks
@mergify mergify bot closed this as completed in #4007 Sep 6, 2023
mergify bot pushed a commit that referenced this issue Sep 6, 2023
@tsuf239
feat(docs): add variadic params to jsii docgen (#4007)
52b44ca 
closes [#3781](#3781)
<img width="951" alt="image" src="https://github.com/winglang/wing/assets/39455181/bfecb78b-812e-4483-aac6-cc5f83103f3e">

## Checklist

- [x] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted)
- [x] Description explains motivation and solution
- [ ] Tests added (always)
- [x] Docs updated (only required for features)
- [ ] Added `pr/e2e-full` label if this feature requires end-to-end testing

*By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.
@monadabot
Copy link
Contributor

Congrats! 🚀 This was released in Wing 0.29.4.

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

@tsuf239 tsuf239

Labels
🐛 bug Something isn't working 📚 documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Wing
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(docs): add variadic params to jsii docgen winglang/wing
4 participants
@Chriscbr @garysassano @tsuf239 @monadabot