move deprecation warning from subscribers_count to watchers_count. #2519
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Subscribers_count shows the actual watchers_count. Many people think they are retrieving the watchers_count, but are actually retrieving the stargazers_count... This is because the GitHub UI is still calling subscribers, "Watchers". To prevent many others from falling into this trap, a warning should be added to the watchers_count property. On top of this, subscribers_count is no longer deprecated as far as the GitHub documentation goes. Fixes octokit#2509 Signed-off-by: Brend Smits <[email protected]>
nickfloyd
approved these changes
Aug 2, 2022
|
release_notes: Updates deprecation warning from subscribers_count to watchers_count |
nickfloyd
added
Type: Documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subscribers_count shows the actual watchers_count. Many people think they are retrieving the watchers_count, but are actually retrieving the stargazers_count...
This is because the GitHub UI is still calling subscribers, "Watchers".
To prevent many others from falling into this trap, a warning should be added to the watchers_count property.
On top of this, subscribers_count is no longer deprecated as far as the GitHub documentation goes.
Fixes #2509
Signed-off-by: Brend Smits [email protected]