Skip to content

Commit

Permalink
docs: update doc comment on try_proxy_from_env method to reflect th…
Browse files Browse the repository at this point in the history
…e `proxy-from-env` feature flag
  • Loading branch information
toymil authored and algesten committed Nov 22, 2023
1 parent 395218d commit 89a69a5
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/agent.rs
Original file line number Diff line number Diff line change
Expand Up @@ -325,8 +325,9 @@ impl AgentBuilder {

/// Attempt to detect proxy settings from the environment, i.e. HTTP_PROXY
///
/// The default is `false`, i.e. not detecting proxy from env since this is
/// a potential security risk.
/// The default is `false` without the `proxy-from-env` feature flag, i.e.
/// not detecting proxy from env, due to the potential security risk and to
/// maintain backward compatibility.
///
/// If the `proxy` is set on the builder, this setting has no effect.
pub fn try_proxy_from_env(mut self, do_try: bool) -> Self {
Expand Down

0 comments on commit 89a69a5

Please sign in to comment.