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.

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

Remove type information from JSDoc in .ts files #12090

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

samwho
Copy link
Collaborator

@samwho samwho commented Oct 17, 2023

Description

The type information in the JSDoc comments on our TypeScript files is redundant. The TypeScript types are the source of truth and get checked on CI, so this PR removes the types in the JSDoc.

Documentation

  • I have reviewed the budibase documentatation to verify if this feature requires any changes. If changes or new docs are required I have written them.

Feature branch env

Feature Branch Link

Copy link
Collaborator

@mike12345567 mike12345567 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@samwho samwho enabled auto-merge October 18, 2023 10:46
@codecov-commenter
Copy link

codecov-commenter commented Oct 18, 2023

Codecov Report

Merging #12090 (f9bff08) into master (6167920) will decrease coverage by 12.03%.
Report is 10 commits behind head on master.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@             Coverage Diff             @@
##           master   #12090       +/-   ##
===========================================
- Coverage   68.50%   56.48%   -12.03%     
===========================================
  Files         585      259      -326     
  Lines       21838     7935    -13903     
  Branches     4409     1478     -2931     
===========================================
- Hits        14961     4482    -10479     
+ Misses       6363     3165     -3198     
+ Partials      514      288      -226     
Files Coverage Δ
packages/backend-core/src/cache/appMetadata.ts 57.14% <ø> (ø)
packages/backend-core/src/cache/user.ts 50.00% <ø> (ø)
packages/backend-core/src/configs/configs.ts 71.28% <ø> (ø)
packages/backend-core/src/context/mainContext.ts 53.24% <ø> (ø)
packages/backend-core/src/db/Replication.ts 8.57% <ø> (ø)
packages/backend-core/src/db/lucene.ts 84.61% <ø> (ø)
packages/backend-core/src/db/utils.ts 49.00% <ø> (ø)
packages/backend-core/src/docIds/conversions.ts 81.25% <ø> (ø)
packages/backend-core/src/docIds/ids.ts 30.76% <ø> (ø)
packages/backend-core/src/docIds/params.ts 15.09% <ø> (ø)
... and 14 more

... and 326 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@samwho samwho merged commit 1ab52f3 into master Oct 18, 2023
9 of 10 checks passed
@samwho samwho deleted the refactor/remove-jsdoc-types-in-ts-files branch October 18, 2023 10:57
@github-actions github-actions bot locked and limited conversation to collaborators Oct 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants