chore: Fix XML comments in AppiumCommandExecutionHelper.cs #950
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
In AppiumCommandExecutionHelper.cs Inspired by appium#733.
Collaborator
|
@seriousQA, thanks for your contribution! Before we can merge your pull request, please sign the Contributor License Agreement (CLA). |
Contributor
Author
|
@Dor-bl , done! |
Updated parameter descriptions in IHasClipboard interface methods to provide clearer information about expected arguments. Also enabled nullable context in AndroidDriver for improved code safety.
Contributor
Author
|
@Dor-bl , I've added a bit more improvements. |
KazuCocoa
approved these changes
Jul 28, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes XML documentation comments in Appium.Net by adding missing parameter descriptions and correcting existing ones across multiple interface and implementation files.
- Adds missing parameter descriptions to XML comments that previously had empty
<param>tags - Provides descriptive documentation for method parameters in clipboard-related interfaces
- Includes parameter documentation for file operations in AppiumCommandExecutionHelper.cs
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/Appium.Net/Appium/Interfaces/IHasClipboard.cs | Adds descriptive parameter documentation for clipboard operations |
| src/Appium.Net/Appium/AppiumCommandExecutionHelper.cs | Adds missing parameter descriptions for PushFile method |
| src/Appium.Net/Appium/Android/AndroidDriver.cs | Minor formatting change with nullable directive placement |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
List of changes
XML comments fixes (AppiumCommandExecutionHelper.cs).
Inspired by #733.
Types of changes
What types of changes are you proposing/introducing to the .NET client?
Put an
xin the boxes that applyDocumentation
This can be done by navigating to the documentation section on http://appium.io selecting the appropriate command/endpoint and clicking the 'Edit this doc' link to update the C# example
Integration tests
Details
Please provide more details about changes if necessary. You can provide code samples showing how they work and possible use cases if there are new features. Also, you can create gists with pasted C# code samples or put them here using markdown.
About markdown please read Mastering markdown and Writing on GitHub