Skip to content

fix: swap @yields for @returns #178

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
Merged
merged 4 commits into from
Apr 19, 2022
Merged

fix: swap @yields for @returns #178

merged 4 commits into from
Apr 19, 2022

Conversation

gobengo
Copy link
Contributor

@gobengo gobengo commented Apr 11, 2022 •
edited
Loading

Motivation:

Context:

Strategy

  • Use jsdoc @return instead of @yields because tsc doesn't understand that @yields implies a @return type

Test Case

@welcome
Copy link

welcome bot commented Apr 11, 2022

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines
    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

hugomrdias
hugomrdias suggested changes Apr 12, 2022
View reviewed changes
@gobengo gobengo requested a review from hugomrdias April 12, 2022 18:43
@hugomrdias hugomrdias requested a review from achingbrain April 13, 2022 15:09
@gobengo gobengo changed the title src/files/glob-source jsdocs with tsc-supported @return instead of @yields src/files/glob-source jsdocs with tsc-supported @returns instead of @yields Apr 13, 2022
@achingbrain achingbrain changed the title src/files/glob-source jsdocs with tsc-supported @returns instead of @yields fix: swap @yields for @returns Apr 19, 2022
@achingbrain achingbrain merged commit 13e2c9b into ipfs:master Apr 19, 2022
github-actions bot pushed a commit that referenced this pull request Apr 19, 2022
@semantic-release-bot
chore(release): 9.0.6 [skip ci]
5049798 
### [9.0.6](v9.0.5...v9.0.6) (2022-04-19)

### Bug Fixes

* swap [@yields](https://github.com/yields) for [@returns](https://github.com/returns) ([#178](#178)) ([13e2c9b](13e2c9b))
@github-actions
Copy link

🎉 This PR is included in version 9.0.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

@achingbrain achingbrain achingbrain approved these changes

+1 more reviewer

@hugomrdias hugomrdias hugomrdias approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

error importing ipfs-core from TypeScript "Cannot find namespace 'fs'."
3 participants
@gobengo @hugomrdias @achingbrain