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

Added command to run python script to follow first script example #1710

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

Open
sadik312 wants to merge 18 commits into SeleniumHQ:trunk
base: trunk
Choose a base branch
Loading
from sadik312:sadik-feature-branch

Conversation

@sadik312
Copy link

@sadik312 sadik312 commented May 7, 2024 •
edited
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

I have added the command to run the selenium file using Python.

Motivation and Context

This was missing from the documentation.

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)
  • [ x] Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • [ x] 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, enhancement

Description

  • Added a section in examples/python/README.md to provide users with the command to run a Python script, enhancing the usability of the examples.
  • Updated website_and_docs/content/documentation/webdriver/getting_started/first_script.en.md to link directly to the newly added instructions in the examples README, improving the documentation's interactivity and user guidance.

Changes walkthrough 📝

Relevant files
Documentation
README.md
Add Python Script Execution Instructions

examples/python/README.md

  • Added instructions on how to execute a Python script using the command
    line.
    • +8/-0
    first_script.en.md
    Link Python Script Execution in Documentation

    website_and_docs/content/documentation/webdriver/getting_started/first_script.en.md

  • Updated the Python tab to link to the new code block in the examples
    README.
    • +1/-1

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

    A1exKH reacted with thumbs up emoji
    Copy link

    netlify bot commented May 7, 2024 •
    edited
    Loading

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit e9a52e3

    Copy link

    CLAassistant commented May 7, 2024 •
    edited
    Loading

    CLA assistant check
    All committers have signed the CLA.

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation enhancement New feature or request labels May 7, 2024
    Copy link
    Contributor

    qodo-merge-pro bot commented May 7, 2024

    PR Description updated to latest commit (2c7aeb6)

    Copy link
    Contributor

    qodo-merge-pro bot commented May 7, 2024

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and limited to documentation updates. The PR involves adding a new section in a README file and updating a reference in another documentation file.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No newline at end of file: The modified README.md file does not end with a newline. This is not typically a major issue but can lead to problems with version control systems or when concatenating files.

    🔒 Security concerns

    No

    Copy link
    Contributor

    qodo-merge-pro bot commented May 7, 2024 •
    edited
    Loading

    PR Code Suggestions ✨

    CategorySuggestions
    Enhancement
    Add a comment explaining the purpose of the script.

    It's recommended to provide a brief explanation or comment about what example_script.py
    does or what it's used for, especially for new users or readers who might not be familiar
    with the script. This can be added just before the command to run the script.

    examples/python/README.md [37]

    +# This script demonstrates basic Python operations.
    python example_script.py

    

    Maintainability


    ✅ (削除) Verify and maintain the accuracy of the linked path in the documentation. (削除ここまで)

    

    Suggestion Impact:The commit updated all the line references in the gh-codeblock shortcodes throughout the document, including the Python README reference mentioned in the suggestion. The commit shows careful attention to maintaining accurate line references by updating them and even expanding to include ranges (e.g., L18-19 instead of just L19).

    code diff:
    

     {{< tab header="Python" >}}
 {{< gh-codeblock path="examples/python/README.md#L37" >}}
-{{< /tab >}}
    

    

    

    Ensure that the path specified in the gh-codeblock shortcode correctly points to the 
    relevant section of the README. If the line number changes in the README, this reference 
    will need to be updated to maintain accuracy.
    

    website_and_docs/content/documentation/webdriver/getting_started/first_script.en.md [236] 
    

    -{{< gh-codeblock path="examples/python/README.md#L37" >}}
+{{< gh-codeblock path="examples/python/README.md#L37" >}} # Ensure this line number is kept updated with any changes in the README.
 
    

    
     		
 
    
     

    
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
    
 
 
    
 
    
 
 
    
 
 
 
     
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 
 Member

 
 
    
 
    
 
    
 @harsha509
 
 harsha509
 
 
 
 left a comment
 
 
    
 
    

    
 
 
    
 
    
 
 
    
 
 
 
    Choose a reason for hiding this comment
    
 
    
 The reason will be displayed to describe this comment to others. Learn more.
 
    
 
    
 
 

    
 

    
 
 
    
 
    HI @sadik312 ,
    

    Thank you the PR. Could you please make similar changes to other translated files too.
    

    Thanks,
    
Sri
    
 
 
    
     
 

    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

    
 
    
 
    
 
    
 
 
    
 
    
 
 
    
 
    

    
 
    

    

    

    
 
    
 
 
 

     
    

    

    
 
    
 
 

    
 
 

    
 
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 

 Author

 
    
 
    
 
    
 
 
 sadik312
 
 
 
 commented
 May 7, 2024
 
 
    
 
    

    
 
    
 

 
 
     
 
    

    HI @sadik312 ,
    

    Thank you the PR. Could you please make similar changes to other translated files too.
    

    Thanks, Sri
    

    

    Hi @harsha509 ,
    
Yes, I will make the changes to the other files too.
    
Thanks
    
 
 
    
 
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
  A1exKH reacted with thumbs up emoji
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
 
    
 
 
    
 
 
    
 
     @sadik312
 sadik312
 requested a review
 from harsha509
 May 9, 2024 15:09 
 

    

    

    
 
    
 
 
    
 
    
 
 
    
 
 
 
     
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 

 Author

 
    
 
    
 
    
 @sadik312
 
 sadik312
 
 
 
 left a comment
 
 •
 
    
 
 
    
 
 edited
 
 
 
 
    
     
 
 
 
 
  Loading

 
 
 
    
    
 
    
 
    

    
 
 
    
 
    
 
 
    
 
 
 
    Choose a reason for hiding this comment
    
 
    
 The reason will be displayed to describe this comment to others. Learn more.
 
    
 
    
 
 

    
 

    
 
 
    
 
    I have added README.md files for the examples for:
    

      

    • dotnet
      • 

    • java
      • 

    • kotlin
      • 

    

    I have added the file execution command for:
    

      

    • python
      • 

    

    I have also reflected all of the changes in the first_script.en.md file
    
 
 
    
     
 

    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

    
 
    
 
    
 
    
 
 
    
 
    
 
 
    
 
    

    
 
    

    

    

    
 
    
 
 
 

     
    

    

    
 
 
    
 
 
    
 
    
 
 
    
 
 
 
     
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 
 Member

 
 
    
 
    
 
    
 @harsha509
 
 harsha509
 
 
 
 left a comment
 
 
    
 
    

    
 
 
    
 
    
 
 
    
 
 
 
    Choose a reason for hiding this comment
    
 
    
 The reason will be displayed to describe this comment to others. Learn more.
 
    
 
    
 
 

    
 

    
 
 
    
 
    Hi @sadik312 ,
    

    Thank you for the changes. However, there seem to be some conflicts within the PR. Please could you resolve these when you get a chance?
    

    Thanks,
    
Sri
    
 
 
    
     
 

    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

    
 
    
 
    
 
    
 
 
    
 
    
 
 
    
 
    

    
 
    

    

    

    
 
    
 
 
 

     
    

    

    
 
 
    
 
 

    
 
 

    
 
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 

 Author

 
    
 
    
 
    
 
 
 sadik312
 
 
 
 commented
 Jul 9, 2024
 
 •
 
    
 
 
    
 
 edited
 
 
 
 
    
     
 
 
 
 
  Loading

 
 
 
    
    
 
    
 
    

    
 
    
 

 
 
     
 
    Hi @harsha509,
    
I have fixed the conflict. I added the guide for Gradle and someone else added the guide for Maven and I have merged the 2 together. Please let me know if there are any other issues.
    
Thank you,
    
Sadik
    
 
 
    
 
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
 
    
 
 
    
 
    
 
 
    
 
 
 
     
 
 
 
    
 
 
     
 
 
 
 
 

 

    

    
     
    

    

     
    

    

    
 
 
    
 
 

    
 
 

    
 
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 
 Member

 
 
    
 
    
 
 
    

    
 
    
 

 
 
     
 
    Hi @sadik312 ,
    

    Also could you please resolve conflicts!
    

    Thanks,
    
Sri
    
 
 
    
 
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
  sadik312 reacted with thumbs up emoji
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
 
    
 
 
    
 
    
 
 
    
 
 
 
     
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
 
    
 
    
 @A1exKH
 
 A1exKH
 
 
 
 left a comment
 
 
    
 
    

    
 
 
    
 
    
 
 
    
 
 
 
    Choose a reason for hiding this comment
    
 
    
 The reason will be displayed to describe this comment to others. Learn more.
 
    
 
    
 
 

    
 

    
 
 
    
 
    @sadik312 LGTM.
    
 
 
    
     
 

    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

    
 
    
 
    
 
    
 
 
    
  sadik312 reacted with thumbs up emoji
 
    
 
 
    
 
    

    
 
    

    

    

    
 
    
 
 
 

     
    

    

    
 
 
 
    
 
 

    
 
 

    
 
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 

 Author

 
    
 
    
 
 
    

    
 
    
 

 
 
     
 
    Hi @harsha509,
    
Would you be able to approve this PR?
    
Thank you
    
 
 
    
 
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
 
    
 
 
    
 
    
 
 
    
 
 
 
     
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
 
    
 
    
 @A1exKH
 
 A1exKH
 
 
 
 left a comment
 
 
    
 
    

    
 
 
    
 
    
 
 
    
 
 
 
    Choose a reason for hiding this comment
    
 
    
 The reason will be displayed to describe this comment to others. Learn more.
 
    
 
    
 
 

    
 

    
 
 
    
 
    LGTM.
    
 
 
    
     
 

    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

    
 
    
 
    
 
    
 
 
    
  sadik312 reacted with thumbs up emoji
 
    
 
 
    
 
    

    
 
    

    

    

    
 
    
 
 
 

     
    

    

    
 
    
 
 

    
 
 

    
 
    
 
    
 
    
 
    
  
 
 

 

 
 
 
 
 Copy link
 
    
         
 
    
 
    
 
    
 
 

 Author

 
    
 
    
 
    
 
 
 sadik312
 
 
 
 commented
 Mar 3, 2025
 
 
    
 
    

    
 
    
 

 
 
     
 
    Hi @harsha509,
    
Just wanted to check if you could review my PR when you have some time. Let me know if any changes are needed. Thank you
    
 
 
    
 
    
 
    
 
 
 
    
 
    
 
    
 
 
 
    
 
    
 
 
    
 
    

    
 
    
 
    
 
    
 
    
 
 
 
    
 
 
 
 

 
    
 
 
    

     
    

    

    

    
 
 
 
    
 
    
 

     
    
 
 
    
 
    
 
    
 
 
    
 
 Sign up for free
 to join this conversation on GitHub.
 Already have an account?
 Sign in to comment
 

    
 
    
 
    
 
    

    
 
     

    
 
    
 
    
 
 
 
 
    
 Reviewers
 
    
 
 
    
 

 
 @harsha509
 
 harsha509
 
  Awaiting requested review from harsha509
 
 
    
 
    
 
 1 more reviewer
 
 
 
 
    
 
    
 

 
 @A1exKH
 
 A1exKH
 
 
 
 
 
 
 A1exKH approved these changes
 
    
 
    
 
    
 Reviewers whose approvals may not affect merge requirements
 
    
 Requested changes must be addressed to merge this pull request.
 
    
    

    
 
 
    
 
    
 
 
    
 Assignees
 
    
 

 No one assigned


    
 

    
 
 
    
 Labels
 
    
 
    
 

 documentation

 Improvements or additions to documentation
 

 enhancement

 New feature or request
 

 Review effort [1-5]: 2


    

    
 
 
    
 
    
 
    
 Projects
 
    
 

 None yet


     
    
 

    
 
    
 
 
    
 Milestone
 
    
 No milestone

    
 
 
 

    
 
    
 
    
 
 
    
 
 
    
 Development
 
    
 

    Successfully merging this pull request may close these issues.
    

 
 


         
 
    
 
    

    
     
 
 
 
 
 
 

    

    
 

     
    
 
    
 
 
    
 
    

 
    
 
    
 
    
 
 
 
 
 
    
 

    
 

 
    
 
    
 
    
 
    

    

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