docs: add readTimeout param description to RequestOptions scaladoc - #2958
Merged
adamw merged 1 commit intoAug 2, 2026
Merged
Conversation
The readTimeout field was missing a @param description unlike all other fields in RequestOptions. This adds documentation explaining what it does and notes that http4s backends don't support this option. Closes softwaremill#2835
Member
|
Thanks! |
This file contains hidden or 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
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
Adds the missing description to scaladoc.
Motivation
The field was the only parameter in without a description. This was noted in #2835.
Changes
Testing
Closes #2835