-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Rephrase/reformat a few sentences #1981
Conversation
Replace ``` How to get deal with various problems in your Selenium code ``` with ``` How to solve various problems in your Selenium code ``` to make simpler the description.
Replace ``` How to get manage WebDriver problems ``` with ``` How to solve WebDriver problems ``` to make simpler the description.
Replace ``` WebDriver drives a browser natively ..., marks a leaps forward ``` with ``` WebDriver drives a browser natively .... It marks a leaps forward ``` I claim the version before the change is a 'run-on sentence', i.e. two separate sentences that are connected improperly (see https://academicguides.waldenu.edu/writingcenter/grammar/runonsentences). This commit changes how those two sentences are connected; in particular, it separates the sentences with a period and provides a subject for the second sentence.
The page https://www.selenium.dev/documentation/overview/details/ includes ``` the images are displayed in the same place , ``` I intend this commit removes the space between 'place' and ','.
👷 Deploy request for selenium-dev pending review.Visit the deploys page to approve it
|
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨Explore these optional code suggestions:
|
On page https://www.selenium.dev/documentation/webdriver/drivers/ in section 'Quitting Sessions', the Java code example shows text: ``` {< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >} ``` Instead of this, we want to show the code from that file. This commit adds an extra layer of `{}` in order to show the code. The panels for other languages that work (i.e. Python, Ruby) have this extra layer of `{}`.
Commit c4249e0 addresses code blocks that look like: That is, the commit edits the codeblocks to show code rather than a reference to the location of the code. |
Thank you for the contribution @zipperer ! @harsha1502, these changes look good to me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@zipperer please, resolve conflicts for that PR.
@A1exKH, any help in addition to leaving comments and approving PRs is appreciated. |
That is, apply changes to the branch for my pull request from trunk branch at main repo.
Merged the PR based on above approvals. Thank you @zipperer ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
User description
Description
Make sentences simpler:
with
Replace
with
Replace
with
Remove unnecessary space
Replace
with
Motivation and Context
Improve flow of sentences on website
Types of changes
Checklist
PR Type
documentation
Description
Changes walkthrough 📝
details.en.md
Remove unnecessary space and improve sentence flow
website_and_docs/content/documentation/overview/details.en.md
_index.en.md
Correct run-on sentence in WebDriver description
website_and_docs/content/documentation/webdriver/_index.en.md
_index.en.md
Simplify WebDriver troubleshooting description
website_and_docs/content/documentation/webdriver/troubleshooting/_index.en.md
_index.ja.md
Simplify WebDriver troubleshooting description in Japanese
website_and_docs/content/documentation/webdriver/troubleshooting/_index.ja.md
_index.pt-br.md
Simplify WebDriver troubleshooting description in Portuguese
website_and_docs/content/documentation/webdriver/troubleshooting/_index.pt-br.md
_index.en.md
Clarify description in error understanding section
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md
_index.ja.md
Clarify description in error understanding section in Japanese
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md
_index.pt-br.md
Clarify description in error understanding section in Portuguese
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md