docs: Fix deprecation comments for http package#1335
Merged
Conversation
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.
Summary
Fix deprecation comments for
http, so the package will be automatically marked as "Deprecated" on https://pkg.go.dev/github.com/stretchr/testify/http.Changes
httppackage.Motivation
The official documentation has a special deprecation syntax. It adds yellow background and "Deprecated" tag to the deprecated functions, so the deprecated types and functions are more clearly visible to readers.
Without changes:
With changes in the PR:
How to take these screenshots
testifyrepo.