Skip to content

Fix duplicated-word typos and awkward CLI help phrase in user-facing text#49335

Open
Copilot wants to merge 2 commits intomainfrom
copilot/fix-duplicated-word-typos
Open

Fix duplicated-word typos and awkward CLI help phrase in user-facing text#49335
Copilot wants to merge 2 commits intomainfrom
copilot/fix-duplicated-word-typos

Conversation

Copy link

Copilot AI commented Mar 6, 2026

Fixes several duplicated-word typos and one unidiomatic phrase caught by the text auditor.

  • Docs: Remove the thethe in filebeat-input-container.md, filebeat-input-log.md, filebeat-input-http_endpoint.md
  • Docs: Remove of ofof in exported-fields-system.md
  • CLI: Capitalize error creating file handlerError creating file handler in libbeat/cmd/export/template.go and ilm_policy.go for consistency with adjacent fatal messages
  • CLI: Replace by the momentfor now in libbeat/cmd/completion.go
Original prompt

This section details on the original issue you should resolve

<issue_title>[text-auditor] Fix duplicated-word typos and one awkward CLI help phrase in user-facing text</issue_title>
<issue_description>## Text Improvements

The following user-facing text issues were found in the repository. Each is a low-effort fix.

1. Duplicate word in Filebeat container input docs

File: docs/reference/filebeat/filebeat-input-container.md (line 15)
Current text: Please use the the [\filestream`](/reference/filebeat/filebeat-input-filestream.md) input... **Suggested fix:**Please use the `filestream` input... **Why:** Clear typo (the the`) in user-facing documentation.

2. Duplicate word in Filebeat log input docs

File: docs/reference/filebeat/filebeat-input-log.md (line 15)
Current text: Please use the the [\filestream`](/reference/filebeat/filebeat-input-filestream.md) input... **Suggested fix:**Please use the `filestream` input... **Why:** Clear typo (the the`) in user-facing documentation.

3. Duplicate words in HTTP endpoint input docs

File: docs/reference/filebeat/filebeat-input-http_endpoint.md (line 13)
Current text: ...expression that converts the the JSON body...
Suggested fix: ...expression that converts the JSON body...
Why: Clear grammar typo (the the) in user-facing documentation.

4. Duplicate words in exported fields docs

File: docs/reference/metricbeat/exported-fields-system.md (line 472)
Current text: The total number of of milliseconds spent doing I/Os.
Suggested fix: The total number of milliseconds spent doing I/Os.
Why: Clear typo (of of) in user-facing exported fields text.

5. Inconsistent capitalization in fatal error output

File: libbeat/cmd/export/template.go (line 52), libbeat/cmd/export/ilm_policy.go (line 50)
Current text: error creating file handler: %s
Suggested fix: Error creating file handler: %s
Why: User-facing fatal errors in same command surface are otherwise capitalized (Error exporting ...), making this an unambiguous consistency fix.

6. Awkward CLI help phrase

File: libbeat/cmd/completion.go (line 32)
Current text: Output shell completion code for the specified shell (bash and zsh only by the moment)
Suggested fix: Output shell completion code for the specified shell (bash and zsh only for now)
Why: User-facing help text uses unidiomatic phrasing; correction is clear and low-effort.

Suggested Actions

  • Remove duplicated words in docs/reference/filebeat/filebeat-input-container.md and docs/reference/filebeat/filebeat-input-log.md.
  • Remove duplicated words in docs/reference/filebeat/filebeat-input-http_endpoint.md and docs/reference/metricbeat/exported-fields-system.md.
  • Capitalize error creating file handler in both export command files for consistency.
  • Replace by the moment with for now in CLI completion help text.

What is this? | From workflow: Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on Mar 11, 2026, 1:36 PM UTC

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Mar 6, 2026
@mergify
Copy link
Contributor

mergify bot commented Mar 6, 2026

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @Copilot? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

@botelastic
Copy link

botelastic bot commented Mar 6, 2026

This pull request doesn't have a Team:<team> label.

…text

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix duplicated-word typos in user-facing text Fix duplicated-word typos and awkward CLI help phrase in user-facing text Mar 6, 2026
@strawgate strawgate marked this pull request as ready for review March 6, 2026 23:29
@strawgate strawgate requested review from a team as code owners March 6, 2026 23:29
@strawgate strawgate requested review from belimawr and rdner March 6, 2026 23:29
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Vale Linting Results

Summary: 5 warnings, 2 suggestions found

⚠️ Warnings (5)
File Line Rule Message
docs/reference/filebeat/filebeat-input-container.md 13 Elastic.DontUse Don't use 'just'.
docs/reference/filebeat/filebeat-input-container.md 15 Elastic.DontUse Don't use 'Please'.
docs/reference/filebeat/filebeat-input-container.md 17 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
docs/reference/filebeat/filebeat-input-log.md 15 Elastic.DontUse Don't use 'Please'.
docs/reference/filebeat/filebeat-input-log.md 17 Elastic.Latinisms Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'.
💡 Suggestions (2)
File Line Rule Message
docs/reference/filebeat/filebeat-input-container.md 13 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.
docs/reference/filebeat/filebeat-input-log.md 13 Elastic.WordChoice Consider using 'deactivated, deselected, hidden, turned off, unavailable' instead of 'disabled', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

@coderabbitai
Copy link

coderabbitai bot commented Mar 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1087cfc8-58fe-4d57-9a86-6febdd5c277c

📥 Commits

Reviewing files that changed from the base of the PR and between 7c1607e and bb195e8.

📒 Files selected for processing (7)
  • docs/reference/filebeat/filebeat-input-container.md
  • docs/reference/filebeat/filebeat-input-http_endpoint.md
  • docs/reference/filebeat/filebeat-input-log.md
  • docs/reference/metricbeat/exported-fields-system.md
  • libbeat/cmd/completion.go
  • libbeat/cmd/export/ilm_policy.go
  • libbeat/cmd/export/template.go

📝 Walkthrough

Walkthrough

This pull request addresses seven user-facing text corrections across documentation and CLI help text. Changes include removing duplicate words ("the the" and "of of") in Filebeat and Metricbeat documentation files, capitalizing error messages in export command modules for consistency, and replacing the phrase "by the moment" with "for now" in completion command help text. All modifications are textual adjustments with no functional impact.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed All code changes directly address the objectives from issue #49267: duplicated words removed in 4 docs files, error message capitalization fixed in 2 export command files, and CLI help phrase improved in completion command.
Out of Scope Changes check ✅ Passed All changes are narrowly scoped to fixing user-facing text issues as specified in issue #49267; no unrelated modifications detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/fix-duplicated-word-typos
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Labels

needs_team Indicates that the issue/PR needs a Team:* label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[text-auditor] Fix duplicated-word typos and one awkward CLI help phrase in user-facing text

2 participants