doc(TcpSocket): remove DataTypeConverterAttribute class doc #6743
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
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR streamlines the TCP socket samples by removing all references to DataTypeConverterAttribute and focusing solely on DataPropertyConverterAttribute, while also updating sample converter parameter values. Class diagram for updated MockEntity and converter attributesclassDiagram
class MockEntity {
+byte[]? Header
+byte[]? Body
+int Value1
+int Value2
}
class DataPropertyConverterAttribute {
+Type
+Offset
+Length
}
MockEntity "1" -- "*" DataPropertyConverterAttribute : uses
Flow diagram for updated data conversion configurationflowchart TD
A["service.ConfigureDataConverters"] --> B["options.AddPropertyConverter<MockEntity>(Header, DataPropertyConverterAttribute{Offset=0, Length=2})"]
A --> C["options.AddPropertyConverter<MockEntity>(Body, DataPropertyConverterAttribute{Offset=3, Length=2})"]
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request removes references to the deprecated DataTypeConverterAttribute class from TcpSocket documentation and updates the Longbow.Sockets package version.
- Removes documentation and examples related to
DataTypeConverterAttribute - Updates localization strings to reference only
DataPropertyConverterAttribute - Upgrades Longbow.Sockets package from version 9.0.0 to 9.0.1
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/BootstrapBlazor.Server/Locales/zh-CN.json | Updates Chinese localization to reference DataPropertyConverterAttribute instead of DataTypeConverterAttribute |
| src/BootstrapBlazor.Server/Locales/en-US.json | Updates English localization to reference DataPropertyConverterAttribute instead of DataTypeConverterAttribute |
| src/BootstrapBlazor.Server/Components/Samples/Sockets/SocketFactories.razor | Removes documentation list item about DataTypeConverterAttribute |
| src/BootstrapBlazor.Server/Components/Samples/Sockets/DataEntities.razor | Removes DataTypeConverter examples and documentation, simplifies configuration examples |
| src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj | Updates Longbow.Sockets package version from 9.0.0 to 9.0.1 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| { | ||
| Offset = 0, | ||
| Length = 5 | ||
| Length = 2 |
There was a problem hiding this comment.
The Length value was changed from 5 to 2 for the Header property, but this appears to be an unintended change. The comment on line 103 still states 'read 5 bytes' but the code now specifies Length = 2, creating an inconsistency.
Suggested change
| Length = 2 | |
| Length = 5 |
| options.AddPropertyConverter<MockEntity>(entity => entity.Body, new DataPropertyConverterAttribute() | ||
| { | ||
| Offset = 5, | ||
| Offset = 3, |
There was a problem hiding this comment.
The Offset value was changed from 5 to 3 for the Body property, but this creates an inconsistency with the comment on line 110 which still states 'start from position 5'. Either the comment should be updated to match the new offset or the offset should remain 5.
Suggested change
| Offset = 3, | |
| Offset = 5, |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6743 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 739 739
Lines 31713 31713
Branches 4462 4462
=========================================
Hits 31713 31713
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Link issues
fixes #6742
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Clean up BootstrapBlazor.Server socket documentation and samples by removing DataTypeConverterAttribute references, streamlining examples to use only DataPropertyConverterAttribute, and updating sample converter offsets and lengths.
Enhancements: