Fix code snippets in docs: Uri type, semicolons, property names, example constructor

alexeyzimarev · claude · alexeyzimarev · commit fadfa9b6799e · 2026-03-05T15:09:58.000+01:00
- Fix `new Url(...)` to `new Uri(...)` in configuration example
- Remove stray semicolon in serialization lambda example
- Replace deprecated `MaxTimeout` with `Timeout` in client docs
- Replace `BaseAddress` with `BaseUrl` in HttpClient reuse section
- Fix example constructor to use `RestClientOptions` instead of `IOptions&lt;&gt;`

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/docs/docs/advanced/configuration.md b/docs/docs/advanced/configuration.md
@@ -62,8 +62,8 @@ For example:
 
 ```csharp
 var client = new RestClient(options => {
-    options.BaseUrl = new Url("https://localhost:5000/api"),
-    options.DisableCharset = true
+    options.BaseUrl = new Uri("https://localhost:5000/api");
+    options.DisableCharset = true;
 });
 ```
 
diff --git a/docs/docs/advanced/serialization.md b/docs/docs/advanced/serialization.md
@@ -16,7 +16,7 @@ You can tell RestSharp to use a custom serializer by using the `configureSeriali
 ```csharp
 var client = new RestClient(
     options, 
-    configureSerialization: s => s.UseSerializer(() => new CustomSerializer());
+    configureSerialization: s => s.UseSerializer(() => new CustomSerializer())
 );
 ```
 
diff --git a/docs/docs/usage/client.md b/docs/docs/usage/client.md
@@ -24,7 +24,7 @@ Here's an example of how to create a client using the same base path as in the p
 ```csharp
 // Creates a client using the options object
 var options = new RestClientOptions("https://localhost:5000") {
-    MaxTimeout = 1000
+    Timeout = TimeSpan.FromSeconds(1)
 };
 var client = new RestClient(options);
 ```
@@ -47,7 +47,7 @@ Another way to create the client instance is to use a simple client factory. The
 * `RemoteCertificateValidationCallback`
 * `ClientCertificates`
 * `MaxRedirects`
-* `MaxTimeout`
+* `Timeout`
 * `UserAgent`
 * `Expect100Continue`
 
@@ -66,8 +66,8 @@ RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to r
 
 One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work:
 
-- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already.
-- `MaxTimeout` is used to cancel the call using the cancellation token source, so
+- `BaseUrl` will be taken from `httpClient.BaseAddress` if not set explicitly.
+- `Timeout` is used to cancel the call using the cancellation token source.
 - `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required.
 - `Expect100Continue`
 
diff --git a/docs/docs/usage/example.md b/docs/docs/usage/example.md
@@ -76,11 +76,18 @@ public class TwitterClient : ITwitterClient, IDisposable {
 It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor:
 
 ```csharp
-public class TwitterClientOptions(string ApiKey, string ApiSecret);
+public record TwitterClientOptions(string ApiKey, string ApiSecret);
 
 public TwitterClient(IOptions<TwitterClientOptions> options) {
-    var opt = new RestClientOptions("https://api.twitter.com/2");
-    _client = new RestClient(options);
+    var tokenRequest = new OAuth2TokenRequest(
+        "https://api.twitter.com/oauth2/token",
+        options.Value.ApiKey,
+        options.Value.ApiSecret
+    );
+    var opt = new RestClientOptions("https://api.twitter.com/2") {
+        Authenticator = new OAuth2ClientCredentialsAuthenticator(tokenRequest)
+    };
+    _client = new RestClient(opt);
 }
 ```
 
diff --git a/docs/versioned_docs/version-v114/advanced/configuration.md b/docs/versioned_docs/version-v114/advanced/configuration.md
@@ -62,8 +62,8 @@ For example:
 
 ```csharp
 var client = new RestClient(options => {
-    options.BaseUrl = new Url("https://localhost:5000/api"),
-    options.DisableCharset = true
+    options.BaseUrl = new Uri("https://localhost:5000/api");
+    options.DisableCharset = true;
 });
 ```
 
diff --git a/docs/versioned_docs/version-v114/advanced/serialization.md b/docs/versioned_docs/version-v114/advanced/serialization.md
@@ -16,7 +16,7 @@ You can tell RestSharp to use a custom serializer by using the `configureSeriali
 ```csharp
 var client = new RestClient(
     options, 
-    configureSerialization: s => s.UseSerializer(() => new CustomSerializer());
+    configureSerialization: s => s.UseSerializer(() => new CustomSerializer())
 );
 ```
 
diff --git a/docs/versioned_docs/version-v114/usage/client.md b/docs/versioned_docs/version-v114/usage/client.md
@@ -24,7 +24,7 @@ Here's an example of how to create a client using the same base path as in the p
 ```csharp
 // Creates a client using the options object
 var options = new RestClientOptions("https://localhost:5000") {
-    MaxTimeout = 1000
+    Timeout = TimeSpan.FromSeconds(1)
 };
 var client = new RestClient(options);
 ```
@@ -47,7 +47,7 @@ Another way to create the client instance is to use a simple client factory. The
 * `RemoteCertificateValidationCallback`
 * `ClientCertificates`
 * `MaxRedirects`
-* `MaxTimeout`
+* `Timeout`
 * `UserAgent`
 * `Expect100Continue`
 
@@ -66,8 +66,8 @@ RestSharp uses `HttpClient` internally to make HTTP requests. It's possible to r
 
 One way of doing it is to use `RestClient` constructors that accept an instance of `HttpClient` or `HttpMessageHandler` as an argument. Note that in that case not all the options provided via `RestClientOptions` will be used. Here is the list of options that will work:
 
-- `BaseAddress` is be used to set the base address of the `HttpClient` instance if base address is not set there already.
-- `MaxTimeout` is used to cancel the call using the cancellation token source, so
+- `BaseUrl` will be taken from `httpClient.BaseAddress` if not set explicitly.
+- `Timeout` is used to cancel the call using the cancellation token source.
 - `UserAgent` will be added to the `RestClient.DefaultParameters` list as a HTTP header. This will be added to each request made by the `RestClient`, and the `HttpClient` instance will not be modified. This is to allow the `HttpClient` instance to be reused for scenarios where different `User-Agent` headers are required.
 - `Expect100Continue`
 
diff --git a/docs/versioned_docs/version-v114/usage/example.md b/docs/versioned_docs/version-v114/usage/example.md
@@ -76,11 +76,18 @@ public class TwitterClient : ITwitterClient, IDisposable {
 It is also possible to use ASP.NET Core Options for configuring the client, instead of passing the credentials as strings. For example, we can add a class for Twitter client options, and use it in a constructor:
 
 ```csharp
-public class TwitterClientOptions(string ApiKey, string ApiSecret);
+public record TwitterClientOptions(string ApiKey, string ApiSecret);
 
 public TwitterClient(IOptions<TwitterClientOptions> options) {
-    var opt = new RestClientOptions("https://api.twitter.com/2");
-    _client = new RestClient(options);
+    var tokenRequest = new OAuth2TokenRequest(
+        "https://api.twitter.com/oauth2/token",
+        options.Value.ApiKey,
+        options.Value.ApiSecret
+    );
+    var opt = new RestClientOptions("https://api.twitter.com/2") {
+        Authenticator = new OAuth2ClientCredentialsAuthenticator(tokenRequest)
+    };
+    _client = new RestClient(opt);
 }
 ```
 
