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

Update first_script.en.md #1780

Open
wants to merge 2 commits into
base: trunk
Choose a base branch
from
Open

Conversation

darrenqchen
Copy link

@darrenqchen darrenqchen commented Jun 24, 2024

User description

In step 7 for Python, the code block is missing line 18 from examples/python/tests/getting_started/first_script.py which creates the message variable. This way people that are following along the "getting_started" tutorial won't be as confused.

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

  • Updated the Python code block reference in the "Getting Started" tutorial to include line 18, ensuring the message variable creation is visible.
  • This change helps users following the tutorial to avoid confusion.

Changes walkthrough 📝

Relevant files
Documentation
first_script.en.md
Fix missing line in Python code block for tutorial             

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

  • Updated Python code block reference to include line 18.
  • Ensured the creation of the message variable is included in the
    tutorial.
  • +1/-1     

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

    In step 7 for Python, the code block is missing line 18 which creates the message variable. This way people that are following along the `"getting_started"` tutorial won't be as confused.
    Copy link

    netlify bot commented Jun 24, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 59b19e9

    @CLAassistant
    Copy link

    CLAassistant commented Jun 24, 2024

    CLA assistant check
    All committers have signed the CLA.

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Jun 24, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5] 1
    🧪 Relevant tests No
    🔒 Security concerns No
    ⚡ Key issues to review None

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for PR.

    @darrenqchen
    Copy link
    Author

    Found this error since I was trying to do the tutorial myself for the first time.

    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 @darrenqchen ,

    Thank you for the PR.

    Your feedback is indeed beneficial in our efforts towards refining and enhancing our documentation.

    To maintain consistency across all language versions, could you please replicate the changes you made on the main page to the other translated pages (pt-br, zh-cn, ja)?

    If you need any assistance or prefer me to implement the changes, kindly let me know.

    Thanks,
    Sri

    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]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants