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

added quitting examples for all lanaguges/translations #1882

Closed

Conversation

shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Aug 21, 2024

User description

Added code examples for driver.quit in all languages and translations

Description

Added code examples for driver.quit in all languages and translations

Motivation and Context

documentation should be as comprehensive as possible

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation


Description

  • Added driver.quit code examples in multiple languages including Java, CSharp, JavaScript, and Kotlin.
  • Enhanced documentation across English, Japanese, Portuguese, and Chinese translations.
  • Improved comprehensiveness of the documentation by providing practical code examples.

Changes walkthrough 📝

Relevant files
Documentation
_index.en.md
Add `driver.quit` code examples in multiple languages       

website_and_docs/content/documentation/webdriver/drivers/_index.en.md

  • Added code example links for driver.quit in Java, CSharp, JavaScript,
    and Kotlin.
  • Enhanced documentation with practical examples.
  • +4/-0     
    _index.ja.md
    Add `driver.quit` code examples in Japanese documentation

    website_and_docs/content/documentation/webdriver/drivers/_index.ja.md

  • Added code example links for driver.quit in Java, CSharp, JavaScript,
    and Kotlin.
  • Improved Japanese documentation with code examples.
  • +4/-0     
    _index.pt-br.md
    Add `driver.quit` code examples in Portuguese documentation

    website_and_docs/content/documentation/webdriver/drivers/_index.pt-br.md

  • Added code example links for driver.quit in Java, CSharp, JavaScript,
    and Kotlin.
  • Enhanced Portuguese documentation with practical examples.
  • +4/-0     
    _index.zh-cn.md
    Add `driver.quit` code examples in Chinese documentation 

    website_and_docs/content/documentation/webdriver/drivers/_index.zh-cn.md

  • Added code example links for driver.quit in Java, CSharp, JavaScript,
    and Kotlin.
  • Improved Chinese documentation with code examples.
  • +4/-0     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link

    netlify bot commented Aug 21, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 75eef14

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the documentation Improvements or additions to documentation label Aug 21, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Incorrect Code Example
    The code example for CSharp is incorrectly using the Java example path.

    Incorrect Code Example
    The code example for CSharp is incorrectly using the Java example path.

    Incorrect Code Example
    The code example for CSharp is incorrectly using the Java example path.

    Incorrect Code Example
    The code example for CSharp is incorrectly using the Java example path.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Bug fix
    Correct the file path for the CSharp code example

    The code block for CSharp is incorrectly using the Java example path. Replace it
    with the correct CSharp example path.

    website_and_docs/content/documentation/webdriver/drivers/_index.en.md [70-73]

     {{< tab header="CSharp" >}}
    -{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    +{< gh-codeblock path="examples/dotnet/SeleniumDocs/GettingStarted/FirstScriptTest.cs#L29" >}
     {{< badge-code >}}
     {{< /tab >}}
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies a bug where the CSharp code block is using a Java example path, which is a significant issue that needs to be fixed for clarity and accuracy.

    9
    Correct the file path for the CSharp code example in the Japanese translation

    The code block for CSharp is incorrectly using the Java example path. Replace it
    with the correct CSharp example path.

    website_and_docs/content/documentation/webdriver/drivers/_index.ja.md [69-72]

     {{< tab header="CSharp" >}}
    -{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    +{< gh-codeblock path="examples/dotnet/SeleniumDocs/GettingStarted/FirstScriptTest.cs#L29" >}
     {{< badge-code >}}
     {{< /tab >}}
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: This suggestion addresses the same critical issue in the Japanese translation, ensuring consistency and correctness across different language versions.

    9
    Correct the file path for the CSharp code example in the Portuguese translation

    The code block for CSharp is incorrectly using the Java example path. Replace it
    with the correct CSharp example path.

    website_and_docs/content/documentation/webdriver/drivers/_index.pt-br.md [70-73]

     {{< tab header="CSharp" >}}
    -{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    +{< gh-codeblock path="examples/dotnet/SeleniumDocs/GettingStarted/FirstScriptTest.cs#L29" >}
     {{< badge-code >}}
     {{< /tab >}}
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion fixes the incorrect file path in the Portuguese translation, which is essential for maintaining the accuracy of the documentation.

    9
    Correct the file path for the CSharp code example in the Chinese translation

    The code block for CSharp is incorrectly using the Java example path. Replace it
    with the correct CSharp example path.

    website_and_docs/content/documentation/webdriver/drivers/_index.zh-cn.md [70-73]

     {{< tab header="CSharp" >}}
    -{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    +{< gh-codeblock path="examples/dotnet/SeleniumDocs/GettingStarted/FirstScriptTest.cs#L29" >}
     {{< badge-code >}}
     {{< /tab >}}
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Correcting the file path in the Chinese translation is crucial for ensuring that the documentation is accurate and useful for all users.

    9

    {{< badge-code >}}
    {{< /tab >}}
    {{% tab header="Python" %}}
    {{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}
    {{% /tab %}}
    {{< tab header="CSharp" >}}
    {< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Hi @shbenzer ,
    thank you for the PR.

    the code is pointing to java file, it should point to c# code

    {{< badge-code >}}
    {{< /tab >}}
    {{% tab header="Python" %}}
    {{< gh-codeblock path="examples/python/tests/drivers/test_options.py#L13" >}}
    {{% /tab %}}
    {{< tab header="CSharp" >}}
    {< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L29" >}
    Copy link
    Member

    Choose a reason for hiding this comment

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

    same as above...!

    @harsha509 harsha509 mentioned this pull request Aug 22, 2024
    6 tasks
    @shbenzer shbenzer closed this Aug 22, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants