Skip to content

fix: correct typo in "Downloading a file" section across multiple language documentation files#2663

Open
noritaka1166 wants to merge 1 commit into
SeleniumHQ:trunkfrom
noritaka1166:fix-typos-grid-configration
Open

fix: correct typo in "Downloading a file" section across multiple language documentation files#2663
noritaka1166 wants to merge 1 commit into
SeleniumHQ:trunkfrom
noritaka1166:fix-typos-grid-configration

Conversation

@noritaka1166

Copy link
Copy Markdown
Contributor

Description

Corrected a typo in the "Downloading a file" heading in the Grid CLI options documentation.

Updated the same typo from Dowloading to Downloading across the English, Japanese, Portuguese (Brazil), and Chinese documentation files.

Motivation and Context

This fixes a small spelling error in the documentation heading and keeps the translated documentation files consistent with the English version.

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.

@netlify

netlify Bot commented Jun 20, 2026

Copy link
Copy Markdown

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 40ce86f

@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Fix typo in Grid CLI docs heading across translations
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description

• Fix typo in Grid CLI options “Downloading a file” section heading.
• Apply the same correction consistently across EN, JA, PT-BR, and ZH-CN docs.
High-Level Assessment

Current approach is optimal: directly correct the heading typo in the source English doc and keep translated variants in sync. Alternatives (e.g., centralizing shared strings) are out of scope for a one-word documentation fix.

Files changed (4) +4 / -4

Documentation (4) +4 / -4
cli_options.en.mdCorrect “Dowloading” heading typo in EN Grid CLI docs +1/-1

Correct “Dowloading” heading typo in EN Grid CLI docs

• Fixes the section heading spelling from “Dowloading a file” to “Downloading a file” to improve documentation correctness.

website_and_docs/content/documentation/grid/configuration/cli_options.en.md

cli_options.ja.mdSync heading typo fix in JA Grid CLI docs +1/-1

Sync heading typo fix in JA Grid CLI docs

• Updates the same section heading typo to match the corrected English heading and keep translations consistent.

website_and_docs/content/documentation/grid/configuration/cli_options.ja.md

cli_options.pt-br.mdSync heading typo fix in PT-BR Grid CLI docs +1/-1

Sync heading typo fix in PT-BR Grid CLI docs

• Corrects the “Downloading a file” section heading spelling to match the English documentation and maintain consistency.

website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md

cli_options.zh-cn.mdSync heading typo fix in ZH-CN Grid CLI docs +1/-1

Sync heading typo fix in ZH-CN Grid CLI docs

• Fixes the section heading typo so the translated documentation matches the corrected English heading.

website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md

@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Remediation recommended

1. Malformed JSON payload example 🐞 Bug ≡ Correctness
Description
In the “Downloading a file” section, the documented POST payload example is missing the closing
quote and brace, so users copying it will send invalid JSON. The same malformed snippet appears in
the English, Japanese, Portuguese (Brazil), and Chinese versions of this page.
Code

website_and_docs/content/documentation/grid/configuration/cli_options.en.md[461]

* The endpoint to `POST` from is `/session/<sessionId>/se/files` with a payload of the form `{"name": "fileNameGoesHere}`
Evidence
All four docs files show the same inline payload with a missing closing quote and brace, making it
invalid JSON as written.

website_and_docs/content/documentation/grid/configuration/cli_options.en.md[459-462]
website_and_docs/content/documentation/grid/configuration/cli_options.ja.md[419-422]
website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md[422-425]
website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md[428-431]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The docs currently show an invalid JSON payload for `POST /session/<sessionId>/se/files`: `{"name": "fileNameGoesHere}` is missing the closing `"}`.

### Issue Context
This is user-facing documentation; copy/paste of this payload will fail JSON parsing in typical clients.

### Fix Focus Areas
Update the inline payload example to a valid JSON object (e.g., `{"name": "fileNameGoesHere"}`) in all translated versions:
- website_and_docs/content/documentation/grid/configuration/cli_options.en.md[459-462]
- website_and_docs/content/documentation/grid/configuration/cli_options.ja.md[419-422]
- website_and_docs/content/documentation/grid/configuration/cli_options.pt-br.md[422-425]
- website_and_docs/content/documentation/grid/configuration/cli_options.zh-cn.md[428-431]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant