Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

feature/safari_20240701 #1791

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

Merged
alaahong merged 1 commit into SeleniumHQ:trunk from alaahong:feature/safari——20240701
Jul 1, 2024

The head ref may contain hidden characters: "feature/safari\u2014\u201420240701"

Dismiss

Conversation

@alaahong
Copy link
Member

@alaahong alaahong commented Jul 1, 2024 •
edited by qodo-merge-pro bot
Loading

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Motivation and Context

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

  • Improved the Chinese translation for the Safari WebDriver documentation.
  • Changed section titles from English to Chinese for better localization.
  • Updated references to the Appium project and service settings.
  • Enhanced logging instructions and added notes for Java.

Changes walkthrough 📝

Relevant files
Documentation
safari.zh-cn.md
Improve Chinese translation and update Safari documentation

website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md

  • Improved translation for better clarity and consistency.
  • Changed section titles from English to Chinese.
  • Updated references to the Appium project and service settings.
  • Enhanced logging instructions and added notes for Java.
    • +15/-11

    💡 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 Jul 1, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit eec59e2

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 2 labels Jul 1, 2024
    Copy link
    Contributor

    qodo-merge-pro bot commented Jul 1, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 2
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review Translation Consistency:
    Ensure that the translations are consistent with the terminology used throughout the rest of the documentation.
    Link Verification:
    Verify that the updated links (e.g., to the Appium project) are accessible and correct.

    @alaahong alaahong changed the title (削除) update feature/safari (削除ここまで) (追記) feature/safari_20240701 (追記ここまで) Jul 1, 2024
    Copy link
    Contributor

    qodo-merge-pro bot commented Jul 1, 2024

    PR Code Suggestions ✨

    CategorySuggestion Score
    Best practice
    Maintain the original product names in English to ensure clarity and consistency

    The translation of "Safari Technology Preview" to "Apple 提供了其浏览器的开发版本" changes the meaning
    slightly. It's better to keep the product name in English to maintain clarity and
    consistency, especially for technical terms.

    website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [94] 

    +Apple 提供了其浏览器的开发版本 — [Safari Technology Preview](https://developer.apple.com/safari/technology-preview/)
 
-
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Keeping technical terms and product names in their original language ensures clarity and consistency, which is crucial for technical documentation. This suggestion addresses a best practice for multilingual documentation.

    		9
    Enhancement
    Use HTML tags for line breaks in Markdown to ensure proper rendering

    The new text introduces a line break using a backslash, which is not standard in Markdown
    and might not render as expected. Consider using HTML tags for line breaks if necessary.

    website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [69-71] 

    -**注意**: Java也允许使用环境变量进行设置;\
-属性键: `SafariDriverService.SAFARI_DRIVER_LOGGING`\
+**注意**: Java也允许使用环境变量进行设置;<br>
+属性键: `SafariDriverService.SAFARI_DRIVER_LOGGING`<br>
 属性值: `"true"` 或 `"false"`
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: Using HTML tags for line breaks ensures proper rendering across different Markdown processors, which is important for documentation readability and presentation.

    		8
    Maintainability
    Ensure consistent terminology for external links and references

    Consider using consistent terminology for links and references to external resources. The
    original text used "Appium project" and the new text uses "Appium 项目". It would be better
    to keep the terminology consistent across the document to avoid confusion.

    website_and_docs/content/documentation/webdriver/browsers/safari.zh-cn.md [50] 

    -那些希望在iOS上自动化Safari的人可以参考 [Appium 项目](//appium.io/).
+那些希望在iOS上自动化Safari的人可以参考 [Appium project](//appium.io/).
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Consistent terminology helps avoid confusion and maintains readability, especially in translated documents. However, this is a minor maintainability issue rather than a critical one.

    		7

    @alaahong alaahong merged commit 4ea6ecb into SeleniumHQ:trunk Jul 1, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    No reviews

    Assignees

    No one assigned

    Labels

    documentation Improvements or additions to documentation Review effort [1-5]: 2

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    1 participant

    AltStyle によって変換されたページ (->オリジナル) /