Skip to content

docs: Fix deprecation comments for http package#1335

Merged
dolmen merged 2 commits into
stretchr:masterfrom
alexandear:update-docs-http
Oct 30, 2023
Merged

docs: Fix deprecation comments for http package#1335
dolmen merged 2 commits into
stretchr:masterfrom
alexandear:update-docs-http

Conversation

@alexandear
Copy link
Copy Markdown
Contributor

@alexandear alexandear commented Jan 30, 2023

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

  • Update comments in the http package.

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:

image

image

With changes in the PR:

image

image

How to take these screenshots

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation hacktoberfest-accepted Hacktoberfest pkg-http Change related to package testify/http

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants