Skip to content

fix(docs): исправить опечатки в xml-doc комментариях StandardLibrary#1691

Open
nixel2007 wants to merge 2 commits into
EvilBeaver:developfrom
nixel2007:fix/xmldoc-typos
Open

fix(docs): исправить опечатки в xml-doc комментариях StandardLibrary#1691
nixel2007 wants to merge 2 commits into
EvilBeaver:developfrom
nixel2007:fix/xmldoc-typos

Conversation

@nixel2007
Copy link
Copy Markdown
Collaborator

@nixel2007 nixel2007 commented May 30, 2026

Мелкие опечатки в XML-doc комментариях OneScript.StandardLibrary, которые попадают в синтакс-помощник через OneScriptDocumenter:

  • SystemEnvironmentContext.KernelName — «Имя ядра ОС/» → «Имя ядра ОС» (лишний завершающий слеш).
  • XSIdentityConstraintCategory.Unique — «Ограничение идентичности по опредению уникальности» → «по определению».
  • ConsoleContext — «низкоуровнего манипулирования» → «низкоуровневого».

Только текст комментариев, логика не затронута.

Замечено при обновлении данных синтакс-помощника oscript в 1c-syntax/bsl-language-server#3976.

Summary by CodeRabbit

  • Documentation
    • Corrected XML documentation comments across the standard library:
      • Fixed a trailing character in the kernel name comment.
      • Corrected wording/spelling in an identity-constraint enum description.
      • Fixed spelling in the console context class summary to clarify low-level output handling.

Review Change Stack

- SystemEnvironmentContext.KernelName: «Имя ядра ОС/» → «Имя ядра ОС»
  (лишний завершающий слеш).
- XSIdentityConstraintCategory.Unique: «по опредению» → «по определению».

Опечатки попадают в синтакс-помощник через OneScriptDocumenter.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 30, 2026 09:23
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d2ee19aa-7ba4-4501-b029-51d18e1c5527

📥 Commits

Reviewing files that changed from the base of the PR and between e8b6ccf and 4bc8829.

📒 Files selected for processing (1)
  • src/OneScript.StandardLibrary/Text/ConsoleContext.cs
✅ Files skipped from review due to trivial changes (1)
  • src/OneScript.StandardLibrary/Text/ConsoleContext.cs

📝 Walkthrough

Walkthrough

Three documentation-only edits in the OneScript StandardLibrary: spelling fix in ConsoleContext summary, trailing-slash removal above the KernelName property in SystemEnvironmentContext, and a spelling correction in the XSIdentityConstraintCategory enum member comment. No code or API changes.

Changes

Documentation Corrections

Layer / File(s) Summary
Documentation comment corrections
src/OneScript.StandardLibrary/Text/ConsoleContext.cs, src/OneScript.StandardLibrary/SystemEnvironmentContext.cs, src/OneScript.StandardLibrary/XMLSchema/Enumerations/XSIdentityConstraintCategory.cs
Fixed Russian wording and formatting in XML documentation comments: corrected spelling in ConsoleContext class summary, removed a trailing slash in the KernelName property comment, and corrected wording in the enum member description. No executable or public API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • EvilBeaver

Poem

"I nibble at slashes, tidy each line,
I hop through comments, make wording fine,
A tiny fix, a clearer view,
Rabbit-approved—now read anew! 🐇"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: fixing typos in XML documentation comments in StandardLibrary, which matches all three file modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes two typos in XML-doc comments in OneScript.StandardLibrary that surface in the syntax helper via OneScriptDocumenter.

Changes:

  • Remove stray trailing slash in SystemEnvironmentContext.KernelName summary.
  • Correct «опредению» → «определению» in XSIdentityConstraintCategory.Unique summary.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
src/OneScript.StandardLibrary/SystemEnvironmentContext.cs Removes erroneous trailing «/» in KernelName summary.
src/OneScript.StandardLibrary/XMLSchema/Enumerations/XSIdentityConstraintCategory.cs Fixes spelling «опредению» → «определению».

«низкоуровнего» → «низкоуровневого».

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
nixel2007 added a commit to 1c-syntax/bsl-language-server that referenced this pull request May 30, 2026
…ого)

Та же правка отправлена в апстрим OneScript (PR EvilBeaver/OneScript#1691).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

3 participants