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

KTOR-6501 Update API Docs for HttpClient #4372

Merged
merged 1 commit into from
Oct 18, 2024
Merged

KTOR-6501 Update API Docs for HttpClient #4372

merged 1 commit into from
Oct 18, 2024

Conversation

e5l
Copy link
Member

@e5l e5l commented Oct 7, 2024 •
edited
Loading

KTOR-6501 Add Actionalable KDocs for the HttpClient public API

@e5l e5l requested a review from vnikolova October 17, 2024 12:39
@e5l e5l marked this pull request as ready for review October 17, 2024 12:39
@e5l e5l self-assigned this Oct 17, 2024
@e5l e5l changed the title Update API Docs for HttpClient KTOR-6501 Update API Docs for HttpClient Oct 17, 2024
osipxd
osipxd reviewed Oct 17, 2024
View reviewed changes
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated
@@ -86,6 +1222,14 @@ public class HttpClient(
this.manageEngine = manageEngine
}

private suspend fun x() {
Copy link
Member

Choose a reason for hiding this comment

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

Should it be deleted?

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks, will drop

ktor-client/ktor-client-tests/build.gradle.kts Outdated
@@ -59,6 +59,7 @@ kotlin.sourceSets {
dependencies {
api(project(":ktor-client:ktor-client-apache"))
api(project(":ktor-client:ktor-client-apache5"))
api(project(":ktor-client:ktor-client-cio"))
Copy link
Member

Choose a reason for hiding this comment

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

Seems not related to the docs

Copy link
Member Author

Choose a reason for hiding this comment

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

will drop as well

vnikolova
vnikolova approved these changes Oct 18, 2024
View reviewed changes
Copy link
Contributor

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

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

Looks good to me! I suggested some links corrections to keep them consistent.

ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
ktor-client/ktor-client-core/common/src/io/ktor/client/HttpClient.kt Outdated Show resolved Hide resolved
@e5l
Copy link
Member Author

e5l commented Oct 18, 2024

@vnikolova, thank you for the suggestions! Applied

@e5l @vnikolova
KTOR-6501 Update API Docs for HttpClient
5be33b0 
Co-authored-by:  Vik Nikolova <contact@viknikolova.com>
@e5l e5l merged commit 0bbdf4f into main Oct 18, 2024
2 checks passed
@e5l e5l deleted the e5l/client-docs branch October 18, 2024 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@osipxd osipxd osipxd left review comments

@vnikolova vnikolova vnikolova approved these changes

Assignees

@e5l e5l

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@e5l @osipxd @vnikolova