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

fix(jsdoc): Corrections to jsdoc #8277

Merged
merged 8 commits into from
May 31, 2023
Merged

Conversation

mister-ben
Copy link
Contributor

Description

Corrects some jsodc in Player, especially

  • getter/setters not specifying that they won't return when setting
  • getter/setters that stated they could return the player, very old behaviour

Requirements Checklist

  • Feature implemented / Bug fixed
  • If necessary, more likely in a feature request than a bug fix
    • Change has been verified in an actual browser (Chrome, Firefox, IE)
    • Unit Tests updated or fixed
    • Docs/guides updated
    • Example created (starter template on JSBin)
  • Reviewed by Two Core Contributors

@codecov
Copy link

codecov bot commented May 14, 2023

Codecov Report

Merging #8277 (7542171) into main (f1558c6) will increase coverage by 0.05%.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##             main    #8277      +/-   ##
==========================================
+ Coverage   82.36%   82.41%   +0.05%     
==========================================
  Files         112      112              
  Lines        7483     7483              
  Branches     1804     1804              
==========================================
+ Hits         6163     6167       +4     
+ Misses       1320     1316       -4     
Impacted Files Coverage Δ
src/js/component.js 93.31% <0.00%> (ø)
src/js/mixins/evented.js 98.33% <ø> (ø)
src/js/player.js 90.53% <100.00%> (+0.25%) ⬆️
src/js/utils/dom.js 65.20% <100.00%> (ø)

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

@mister-ben mister-ben changed the title fix(jsdoc): Correct return types in Player fix(jsdoc): Corrections to jsdoc May 18, 2023
@@ -2209,6 +2209,29 @@ QUnit.test('should not allow to register custom player when any player has been
videojs.registerComponent('Player', Player);
});

QUnit.test('setters getters passed to tech', function(assert) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This test is unrelated to the changes but makes Codecov happy as it increases coverage...

@mister-ben mister-ben added the needs: LGTM Needs one or more additional approvals label May 25, 2023
@misteroneill misteroneill merged commit 3af3638 into videojs:main May 31, 2023
edirub pushed a commit to edirub/video.js that referenced this pull request Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: LGTM Needs one or more additional approvals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants