Skip to content

client: deprecate NewClient properly#45250

Merged
thaJeztah merged 1 commit intomoby:masterfrom
corhere:really-deprecate-newclient
Mar 31, 2023
Merged

client: deprecate NewClient properly#45250
thaJeztah merged 1 commit intomoby:masterfrom
corhere:really-deprecate-newclient

Conversation

@corhere
Copy link
Contributor

@corhere corhere commented Mar 31, 2023

The Deprecated: line in NewClient's doc comment was not in a new paragraph, so GoDoc, linters, and IDEs were unaware that it was deprecated. The package documentation also continued to reference NewClient. Update the doc comments to finish documenting that NewClient is deprecated.

- What I did

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

The 'Deprecated:' line in NewClient's doc comment was not in a new
paragraph, so GoDoc, linters, and IDEs were unaware that it was
deprecated. The package documentation also continued to reference
NewClient. Update the doc comments to finish documenting that NewClient
is deprecated.

Signed-off-by: Cory Snider <csnider@mirantis.com>
@corhere corhere added kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. area/docs labels Mar 31, 2023
@corhere corhere added this to the v-next milestone Mar 31, 2023
@corhere corhere requested a review from thaJeztah March 31, 2023 20:20
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@akerouanton akerouanton left a comment

Choose a reason for hiding this comment

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

LGTM

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

Labels

area/docs impact/deprecation kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. process/cherry-picked

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants