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

docs: improve TwitchHelix#getClips javadoc #731

Merged
merged 3 commits into from Feb 21, 2023
Merged

docs: improve TwitchHelix#getClips javadoc #731

merged 3 commits into from Feb 21, 2023

Conversation

Skillkiller
Copy link
Contributor

Prerequisites for Code Changes

  • This pull request follows the code style of the project
  • I have tested this feature

...

Changes Proposed

  • Javadoc comment changed.
  • It is now more obvious in which order the return data is returned (move information to top).
  • The note for the first paramter has been changed so that it now applies to the limit parameter (name change).

...

Additional Information

@iProdigy iProdigy changed the base branch from master to develop February 21, 2023 20:58
iProdigy
iProdigy reviewed Feb 21, 2023
View reviewed changes
Copy link
Member

@iProdigy iProdigy left a comment

Choose a reason for hiding this comment

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

We can remove the rate limit verbiage since it's now outdated (as nearly all helix requests require an access token)

rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java Outdated Show resolved Hide resolved
rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java Outdated Show resolved Hide resolved
rest-helix/src/main/java/com/github/twitch4j/helix/TwitchHelix.java Outdated Show resolved Hide resolved
iProdigy
iProdigy approved these changes Feb 21, 2023
View reviewed changes
Copy link
Member

@iProdigy iProdigy left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

@PhilippHeuer PhilippHeuer changed the title Improve TwitchHelix#getClips javadoc comment docs: improve TwitchHelix#getClips javadoc Feb 21, 2023
@PhilippHeuer PhilippHeuer merged commit a6772f9 into twitch4j:develop Feb 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iProdigy iProdigy iProdigy approved these changes

@PhilippHeuer PhilippHeuer PhilippHeuer approved these changes

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

Successfully merging this pull request may close these issues.

None yet
3 participants
@Skillkiller @iProdigy @PhilippHeuer