doc(http_profile): fix broken code examples in header setter docs - #1954
Open
meliharik wants to merge 1 commit into
Open
doc(http_profile): fix broken code examples in header setter docs#1954meliharik wants to merge 1 commit into
meliharik wants to merge 1 commit into
Conversation
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.
The four header-setter doc comments in
package:http_profilecontain examples that don't compile, plus one wrong receiver. All verified against the package's own tests, which use the correct form.Wrong receiver in the response class
http_profile_response_data.dart:98documentedHttpProfileResponseData.headersListValueswithprofile?.requestData...— copied from the request file. NowresponseData.Setters invoked with call syntax
All four examples called the setters like methods:
headersListValuesandheadersCommaValuesare setters, so this doesn't compile. The package's tests use assignment —http_profile_response_data_test.dart:105:profile.responseData.headersListValues = {The examples now match.
Bracket typos
{'Foo': 'Bar, Baz']});(request:120, response:118) — a]closing a{.headersgetter docs showed the bare map as{'Foo': ['Bar', 'Baz']});(request:137, response:135) — a stray);on what the prose describes as just a map.Each fixed snippet was checked with
dart format --output=none: fails to parse before, parses after.Added a bullet to the existing
0.1.1-wipCHANGELOG section; no version bump.