Skip to content

docs: Improve Typescript JSDocs support #2549

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

Merged
merged 1 commit into from
Apr 1, 2025

Conversation

dplewis
Copy link
Member

@dplewis dplewis commented Apr 1, 2025

Pull Request

Issue

JSDocs @member tag is unsupported in typescript.

https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#unsupported-tags

Approach

  • Replace @member with @property
  • Blacklist unsupported tags

Copy link

parse-github-assistant bot commented Apr 1, 2025

🚀 Thanks for opening this pull request!

Copy link

codecov bot commented Apr 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (44eeacd) to head (a060954).
Report is 4 commits behind head on alpha.

Additional details and impacted files
@@            Coverage Diff            @@
##             alpha     #2549   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         6244      6244           
  Branches      1468      1452   -16     
=========================================
  Hits          6244      6244           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dplewis dplewis requested a review from a team April 1, 2025 23:14
@mtrezza mtrezza merged commit 451ad04 into parse-community:alpha Apr 1, 2025
12 checks passed
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 6.1.0-alpha.5

@parseplatformorg parseplatformorg added the state:released-alpha Released as alpha version label Apr 2, 2025
@dplewis dplewis deleted the ts-jsdocs branch April 2, 2025 14:21
@parseplatformorg
Copy link
Contributor

🎉 This change has been released in version 6.1.1

@parseplatformorg parseplatformorg added the state:released Released as stable version label Apr 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state:released Released as stable version state:released-alpha Released as alpha version
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants