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.

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

improve jsdoc comments for invidious calls #6339

Merged
merged 2 commits into from
Dec 16, 2024
Merged

improve jsdoc comments for invidious calls #6339

merged 2 commits into from
Dec 16, 2024

Conversation

ChunkyProgrammer
Copy link
Member

improve jsdoc comments for invidious

Pull Request Type

  • Other - better type support when using Invidious functions

Description

Improves jsdoc comments by referencing some of the types on the invidious documentation page: https://docs.invidious.io/api/

Desktop

  • OS: Fedora Linux
  • OS Version: 41
  • FreeTube version: 0.22.0 (latest nightly)

@FreeTubeBot FreeTubeBot enabled auto-merge (squash) December 10, 2024 04:11
@github-actions github-actions bot added the PR: waiting for review For PRs that are complete, tested, and ready for review label Dec 10, 2024
@ChunkyProgrammer ChunkyProgrammer changed the title improve jsdoc comments for invidious improve jsdoc comments for invidious calls Dec 10, 2024
absidue
absidue reviewed Dec 12, 2024
View reviewed changes
Copy link
Member

@absidue absidue left a comment

Choose a reason for hiding this comment

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

We should probably base these types off real responses, instead of the docs, as in my experience Invidious' docs don't match the real response data.

src/renderer/views/Channel/Channel.js Outdated Show resolved Hide resolved
@ChunkyProgrammer
Copy link
Member Author

We should probably base these types off real responses, instead of the docs, as in my experience Invidious' docs don't match the real response data.

I mainly looked at the docs but I did verify by looking at our code, the invidious api code and the actual responses so it should be pretty accurate. I also opened a PR to the Invidious documentation repo to add some of the missing data:
iv-org/documentation#616

@FreeTubeBot FreeTubeBot merged commit 61601a5 into FreeTubeApp:development Dec 16, 2024
5 checks passed
@github-actions github-actions bot removed the PR: waiting for review For PRs that are complete, tested, and ready for review label Dec 16, 2024
@ChunkyProgrammer ChunkyProgrammer deleted the improve-jsdoc-comments-for-invidious-calls branch December 16, 2024 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kommunarr kommunarr kommunarr approved these changes

@efb4f5ff-1298-471a-8973-3d47447115dc efb4f5ff-1298-471a-8973-3d47447115dc efb4f5ff-1298-471a-8973-3d47447115dc approved these changes

@absidue absidue absidue approved these changes

@PikachuEXE PikachuEXE Awaiting requested review from PikachuEXE

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ChunkyProgrammer @absidue @efb4f5ff-1298-471a-8973-3d47447115dc @kommunarr @FreeTubeBot