Skip to content
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.

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

docs: address options in the migration guide #929

Merged
merged 3 commits into from
Oct 18, 2023
Merged

Conversation

KazuCocoa
Copy link
Member

I saw a couple of times about this options argument report these days. Lets address it in the migration guide since v3 completely removed the old desired_capabilities

README.md Outdated
@@ -60,6 +60,9 @@ For example, some changes in the Selenium binding could break the Appium client.


### Quick migration guide from v2 to v3
- `options` keyword argument for `webdriver.Remote` such as `XCUITestOptions` instead of `desired_capabilities`
- Available options are https://github.com/appium/python-client/tree/master/appium/options
- Not "new" change, but the `desired_capabilities` has been removed since v3.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo below properly -> property

README.md Outdated
@@ -60,6 +60,9 @@ For example, some changes in the Selenium binding could break the Appium client.


### Quick migration guide from v2 to v3
- `options` keyword argument for `webdriver.Remote` such as `XCUITestOptions` instead of `desired_capabilities`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for webdriver.Remote -> in the webdriver.Remote contructor

@@ -60,6 +60,9 @@ For example, some changes in the Selenium binding could break the Appium client.


### Quick migration guide from v2 to v3
- `options` keyword argument for `webdriver.Remote` such as `XCUITestOptions` instead of `desired_capabilities`
- Available options are https://github.com/appium/python-client/tree/master/appium/options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we may also link the example code below where options are used

README.md Outdated
- `options` keyword argument in the `webdriver.Remote` constructor such as `XCUITestOptions` instead of `desired_capabilities`
- Available options are https://github.com/appium/python-client/tree/master/appium/options
- Please check the [Usage](#usage) below as an exampple.
- Not a "new" change, but the `desired_capabilities` has been removed since v3.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the desired_capabilities argument

@KazuCocoa KazuCocoa changed the title docs: adress options in the migration guide docs: address options in the migration guide Oct 18, 2023
@KazuCocoa KazuCocoa merged commit 1e281bf into master Oct 18, 2023
5 of 16 checks passed
@KazuCocoa KazuCocoa deleted the docs-add-options branch October 18, 2023 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants