8000 Custom filter type improvements by darrylnoakes · Pull Request #598 · no-chris/chord-symbol · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Custom filter type improvements #598

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 3 commits into from
Feb 4, 2023
Merged

Custom filter type improvements #598

merged 3 commits into from
Feb 4, 2023

Conversation

darrylnoakes
Copy link
Contributor

Changes:

  • Brought the TypeScript type up to date with the JSDoc one (included null
    in the return type).
  • Improved the JSDoc type (included Null in the return in the @typedef line). Does this need parens?
  • Improved the parameter name in the TypeScript type.
  • Capitalized the type name.
  • Exported the TypeScript type for easing the typing of custom filter functions.
  • Added a JSDoc comment to the Ultimate Guitar filter factory function.

@darrylnoakes
Improve the custom filter type and export it
fd49585 
- bring the TypeScript type up to date with the JSDoc one (include `null`
in return type, etc.)
- improve the JSDoc type
- improve the parameter name in the TypeScript type
- capitalize the type name
- export the TypeScript type for easing the typing of custom filter functions
@darrylnoakes
Describe and type the Ultimate Guitar filter factory function
bacbcd7
@no-chris no-chris self-assigned this Jan 31, 2023
@no-chris no-chris added t 8000 he enhancement New feature or request label Jan 31, 2023
no-chris
no-chris reviewed Jan 31, 2023
View reviewed changes
Copy link
Owner
@no-chris no-chris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! 👏🏻

@darrylnoakes
Copy link
Contributor Author

While I'm thinking about it: It appears that JSDoc prefers parens around any union, but you don't seem to use this for @returns tags. I'm curious as to the reasons for this?

@no-chris
Copy link
Owner
no-chris commented Feb 2, 2023

Reason is ignorance, until your PRs led me into re-reading jsDoc documentation. If there are more like that I will fix them.

@no-chris no-chris merged commit 70a9741 into no-chris:master Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@no-chris no-chris no-chris left review comments

Assignees

@no-chris no-chris

Labels
enhancement New feature or request
Projects
The ChordMark Project
Status: Archive
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@darrylnoakes @no-chris
0