Improved IsRetriable method reference description #861
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
…he flag does not apply safely to Session.Run because of things like periodic commit and call in tx. Tidied up some compiler warning from incomplete or erroneous XML comments.
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation and fixes compiler warnings in the Neo4j Driver codebase. The main focus is enhancing the IsRetriable method documentation to clarify its limitations with autocommit transactions, while also addressing various XML documentation issues that were generating compiler warnings.
- Enhanced
IsRetriableproperty documentation to warn about autocommit transaction limitations - Fixed incomplete XML documentation comments that were causing compiler warnings
- Changed visibility of internal utility classes from public to internal
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| Neo4j.Driver/Neo4j.Driver/Public/Exceptions/Neo4jException.cs | Enhanced IsRetriable property documentation with autocommit transaction warnings |
| Neo4j.Driver/Neo4j.Driver/Public/TransactionConfig.cs | Added proper XML documentation for constructor parameters |
| Neo4j.Driver/Neo4j.Driver/Public/IAsyncSession.cs | Improved method descriptions to clarify autocommit transaction behavior |
| Neo4j.Driver/Neo4j.Driver/Public/Mapping/ConventionTranslation/StandardCaseParser.cs | Fixed exception reference in XML documentation |
| Neo4j.Driver/Neo4j.Driver/Public/Mapping/RecordObjectMapping.cs | Changed method visibility from public to private |
| Neo4j.Driver/Neo4j.Driver/Internal/Routing/LoadBalancer.cs | Added missing parameter documentation |
| Neo4j.Driver/Neo4j.Driver/Internal/Util/VarLong.cs | Changed class visibility from public to internal |
| Neo4j.Driver/Neo4j.Driver/Internal/Mapping/ConventionTranslation/NoOpConventionTranslator.cs | Changed class visibility from public to internal |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Improved IsRetriable method reference description to highlight that the flag does not apply safely to Session.Run because of things like periodic commit and call in tx.
Tidied up some compiler warning from incomplete or erroneous XML comments.