Skip to content

doc(http_profile): fix broken code examples in header setter docs #1954

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

Merged
brianquinlan merged 1 commit into from
Aug 3, 2026
+8 −6
Merged

doc(http_profile): fix broken code examples in header setter docs #1954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkgs/http_profile/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## 0.1.1-wip

* Fixed unintended HTML tags in doc comments.
* Fixed the code examples in the `headersListValues` and `headersCommaValues`
doc comments.

## 0.1.0

Expand Down
6 changes: 3 additions & 3 deletions pkgs/http_profile/lib/src/http_profile_request_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ final class HttpProfileRequestData {
/// // Foo: Bar
/// // Foo: Baz
///
/// profile?.requestData.headersListValues({'Foo': ['Bar', 'Baz']});
/// profile?.requestData.headersListValues = {'Foo': ['Bar', 'Baz']};
/// ```
set headersListValues(Map<String, List<String>>? value) {
_checkAndUpdate();
Expand All @@ -117,7 +117,7 @@ final class HttpProfileRequestData {
/// // Foo: Bar
/// // Foo: Baz
///
/// profile?.requestData.headersCommaValues({'Foo': 'Bar, Baz']});
/// profile?.requestData.headersCommaValues = {'Foo': 'Bar, Baz'};
/// ```
set headersCommaValues(Map<String, String>? value) {
_checkAndUpdate();
Expand All @@ -134,7 +134,7 @@ final class HttpProfileRequestData {
/// For example, the map
///
/// ```dart
/// {'Foo': ['Bar', 'Baz']});
/// {'Foo': ['Bar', 'Baz']}
/// ```
///
/// represents the headers
Expand Down
6 changes: 3 additions & 3 deletions pkgs/http_profile/lib/src/http_profile_response_data.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ final class HttpProfileResponseData {
/// // Foo: Bar
/// // Foo: Baz
///
/// profile?.requestData.headersListValues({'Foo': ['Bar', 'Baz']});
/// profile?.responseData.headersListValues = {'Foo': ['Bar', 'Baz']};
/// ```
set headersListValues(Map<String, List<String>>? value) {
_checkAndUpdate();
Expand All @@ -115,7 +115,7 @@ final class HttpProfileResponseData {
/// // Foo: Bar
/// // Foo: Baz
///
/// profile?.responseData.headersCommaValues({'Foo': 'Bar, Baz']});
/// profile?.responseData.headersCommaValues = {'Foo': 'Bar, Baz'};
/// ```
set headersCommaValues(Map<String, String>? value) {
_checkAndUpdate();
Expand All @@ -132,7 +132,7 @@ final class HttpProfileResponseData {
/// For example, the map
///
/// ```dart
/// {'Foo': ['Bar', 'Baz']});
/// {'Foo': ['Bar', 'Baz']}
/// ```
///
/// represents the headers
Expand Down
Loading