CommanderStorm commented on code in PR #540:
URL:
https://github.com/apache/arrow-rs-object-store/pull/540#discussion_r2537101058
##########
src/client/mod.rs:
##########
@@ -488,46 +492,76 @@ impl ClientOptions {
self
}
- /// Sets what protocol is allowed. If `allow_http` is :
- /// * false (default): Only HTTPS are allowed
- /// * true: HTTP and HTTPS are allowed
+ /// Sets what protocol is allowed.
+ ///
+ /// If `allow_http` is :
+ /// * `false` (default): Only HTTPS are allowed
+ /// * `true`: HTTP and HTTPS are allowed
pub fn with_allow_http(mut self, allow_http: bool) -> Self {
self.allow_http = allow_http.into();
self
}
/// Allows connections to invalid SSL certificates
- /// * false (default): Only valid HTTPS certificates are allowed
- /// * true: All HTTPS certificates are allowed
///
- /// # Warning
+ /// If `allow_invalid_certificates` is :
+ /// * `false` (default): Only valid HTTPS certificates are allowed
+ /// * `true`: All HTTPS certificates are allowed
+ ///
+ /// <div class="warning">
+ ///
+ /// **Warning**
///
/// You should think very carefully before using this method. If
/// invalid certificates are trusted, *any* certificate for *any* site
/// will be trusted for use. This includes expired certificates. This
/// introduces significant vulnerabilities, and should only be used
/// as a last resort or for testing
+ ///
+ /// </div>
pub fn with_allow_invalid_certificates(mut self, allow_insecure: bool) ->
Self {
self.allow_insecure = allow_insecure.into();
self
}
/// Only use http1 connections
///
- /// This is on by default, since http2 is known to be significantly slower
than http1.
+ /// # See Also
+ /// * [`Self::with_http2_only`] if you only want to use http2
Review Comment:
Changing the instances of the lowercased httpX is consistent with how we
currently do doc comments.
Fixing the Spelling/punctuation is fine though. I fixed it in my last PR to
HTTP/X which is used in the spec.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
