Skip to content

Conversation

@sagittarius-s
Copy link
Contributor

@sagittarius-s sagittarius-s commented Jan 15, 2026

Описание

Изменил форматирование, исправил грамматические ошибки

Связанные задачи

Closes

Чеклист

Общие

  • Ветка PR обновлена из develop
  • Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
  • Изменения покрыты тестами
  • Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

  • Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)

Дополнительно

Summary by CodeRabbit

  • Documentation
    • Improved formatting of diagnostic documentation by converting inline examples to fenced, syntax-highlighted code blocks for clearer readability.
    • Updated source citation to a titled link format to make references easier to navigate.

✏️ Tip: You can customize this high-level summary in your review settings.

Изменил форматирование, исправил грамматические ошибки
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 15, 2026

📝 Walkthrough

Walkthrough

Documentation-only formatting update to docs/diagnostics/QueryNestedFieldsByDot.md: inline code examples were converted to fenced code blocks with "bsl" language specifier and the Sources section was changed to a titled hyperlink. No logic or public API changes.

Changes

Cohort / File(s) Summary
Documentation Formatting
docs/diagnostics/QueryNestedFieldsByDot.md
Converted inline code examples in Examples section to fenced code blocks with bsl language specifier (items 1–5); updated Sources section from plain text to a titled Markdown link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • nixel2007

Poem

🐰✨ With backticks tucked and code blocks bright,

I hopped through docs and fixed the sight.
Links now titled, examples clear,
A tidy change — a joyful cheer! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic. It only states 'Update QueryNestedFieldsByDot.md' without specifying what was updated or why, using generic language that doesn't convey the actual changes made. Consider a more descriptive title that highlights the main change, such as 'Format code examples and update link structure in QueryNestedFieldsByDot.md' or 'Improve documentation formatting in QueryNestedFieldsByDot.md'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/diagnostics/QueryNestedFieldsByDot.md (1)

1-44: Update English documentation to match Russian version formatting and fix example numbering.

The English version at docs/en/diagnostics/QueryNestedFieldsByDot.md exists but has inconsistent formatting. Code examples need to be wrapped in proper markdown code blocks (using ```bsl ``` syntax) instead of inline backticks. Additionally, the example numbering sequence (currently 1-5) should match the Russian version (1, 2, 4, 5, 7), and there's a typo in example 5 where "ГДЕ азКлиентаТовары" should be "ГДЕ ЗаказКлиентаТовары".

🤖 Fix all issues with AI agents
In `@docs/diagnostics/QueryNestedFieldsByDot.md`:
- Around line 35-39: The example numbering in the document is inconsistent (it
jumps from 2 to 4 and from 5 to 7); update the numbered examples so they are
sequential (e.g., renumber the heading/labels around "Разыменование ссылочных
полей в секции \"ГДЕ\"" and the surrounding examples so they proceed
1,2,3,4,5,6,...), or insert the missing example(s) if intended, ensuring the
fenced code block example remains unchanged.
- Around line 22-30: The examples list in QueryNestedFieldsByDot.md is
misnumbered (it jumps to "4. Разыменование ссылочных полей..." after example 2);
update the section headings so examples are sequential (e.g., rename "4.
Разыменование ссылочных полей..." to "3. Разыменование ссылочных полей..." and
adjust any subsequent example numbers to produce 1, 2, 3, 4, 5) or insert the
missing example 3 content if intended, ensuring the fenced code block starting
with "ИЗ    РегистрНакопления.РасчетыСКлиентами.Обороты(" stays unchanged aside
from heading renumbering.
🧹 Nitpick comments (1)
docs/diagnostics/QueryNestedFieldsByDot.md (1)

18-20: Consider replacing hard tabs with spaces.

The markdownlint tool flags hard tabs in the code examples. While these tabs are part of the BSL query formatting, consider replacing them with spaces for consistency with Markdown best practices.

Example fix for lines 18-20

Replace hard tabs with spaces (e.g., 4 spaces per indentation level):

 ИЗ
-	ВТ_РасчетыСКлиентами КАК ВТ_РасчетыСКлиентами
-		ЛЕВОЕ СОЕДИНЕНИЕ ВТ_ДанныеЗаказовКлиента КАК ВТ_ДанныеЗаказовКлиента
-		ПО ВТ_РасчетыСКлиентами.АналитикаУчетаПоПартнерам.Партнер = ВТ_ДанныеЗаказовКлиента.Партнер
+    ВТ_РасчетыСКлиентами КАК ВТ_РасчетыСКлиентами
+        ЛЕВОЕ СОЕДИНЕНИЕ ВТ_ДанныеЗаказовКлиента КАК ВТ_ДанныеЗаказовКлиента
+        ПО ВТ_РасчетыСКлиентами.АналитикаУчетаПоПартнерам.Партнер = ВТ_ДанныеЗаказовКлиента.Партнер

Also applies to: 25-29, 38-38

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61181db and f9b7106.

📒 Files selected for processing (1)
  • docs/diagnostics/QueryNestedFieldsByDot.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/{en/,}diagnostics/**/*.md

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

docs/{en/,}diagnostics/**/*.md: Update diagnostic documentation in both Russian and English with examples of problematic code and fixes
Document configuration parameters if applicable for diagnostics

Files:

  • docs/diagnostics/QueryNestedFieldsByDot.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Update diagnostic documentation in both Russian and English with examples of problematic code and fixes
Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Document configuration parameters if applicable for diagnostics
📚 Learning: 2025-12-18T18:49:48.712Z
Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Update diagnostic documentation in both Russian and English with examples of problematic code and fixes

Applied to files:

  • docs/diagnostics/QueryNestedFieldsByDot.md
🪛 markdownlint-cli2 (0.18.1)
docs/diagnostics/QueryNestedFieldsByDot.md

18-18: Hard tabs
Column: 1

(MD010, no-hard-tabs)


19-19: Hard tabs
Column: 1

(MD010, no-hard-tabs)


20-20: Hard tabs
Column: 1

(MD010, no-hard-tabs)


25-25: Hard tabs
Column: 1

(MD010, no-hard-tabs)


26-26: Hard tabs
Column: 1

(MD010, no-hard-tabs)


27-27: Hard tabs
Column: 1

(MD010, no-hard-tabs)


28-28: Hard tabs
Column: 1

(MD010, no-hard-tabs)


29-29: Hard tabs
Column: 1

(MD010, no-hard-tabs)


38-38: Hard tabs
Column: 1

(MD010, no-hard-tabs)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (25, windows-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (25, macOS-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (25, ubuntu-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build
  • GitHub Check: Analyse
🔇 Additional comments (4)
docs/diagnostics/QueryNestedFieldsByDot.md (4)

12-14: Formatting improvement approved!

Converting inline code to fenced code blocks with the bsl language identifier improves readability and enables syntax highlighting.


16-21: Formatting improvement approved!

The conversion to fenced code blocks improves the documentation structure.


31-34: Formatting improvement approved!

The fenced code block improves readability.


44-44: Sources section improvement approved!

Converting the plain text URL to a titled hyperlink format improves usability and makes the documentation more professional.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Исправил ошибки в нумерации пунктов
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/diagnostics/QueryNestedFieldsByDot.md (1)

1-44: Update the English version to use fenced code blocks matching the Russian version.

The English version at docs/en/diagnostics/QueryNestedFieldsByDot.md has inconsistent formatting. All examples use inline backticks instead of fenced code blocks with the bsl language identifier. This breaks syntax highlighting and readability, especially for multi-line examples (examples 2, 3, and 5). Update all examples to use proper fenced code blocks (bsl ... ) matching the Russian version's formatting.

🧹 Nitpick comments (1)
docs/diagnostics/QueryNestedFieldsByDot.md (1)

16-21: Replace hard tabs with spaces for Markdown consistency.

The code examples contain hard tabs (flagged by markdownlint) on lines 18-20, 25-29, and 38. For consistency and to avoid rendering issues across different editors, please replace tabs with spaces for indentation.

Example fix for lines 16-21
 ```bsl
 ИЗ
-	ВТ_РасчетыСКлиентами КАК ВТ_РасчетыСКлиентами
-		ЛЕВОЕ СОЕДИНЕНИЕ ВТ_ДанныеЗаказовКлиента КАК ВТ_ДанныеЗаказовКлиента
-		ПО ВТ_РасчетыСКлиентами.АналитикаУчетаПоПартнерам.Партнер = ВТ_ДанныеЗаказовКлиента.Партнер
+    ВТ_РасчетыСКлиентами КАК ВТ_РасчетыСКлиентами
+        ЛЕВОЕ СОЕДИНЕНИЕ ВТ_ДанныеЗаказовКлиента КАК ВТ_ДанныеЗаказовКлиента
+        ПО ВТ_РасчетыСКлиентами.АналитикаУчетаПоПартнерам.Партнер = ВТ_ДанныеЗаказовКлиента.Партнер

Apply similar changes to the other code blocks.
</details>


Also applies to: 23-30, 36-39

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: Path: .coderabbit.yaml

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between f9b7106bf4c2e5d0efc6c476f3190f6ff9eca902 and 72cc1f011adb25845f6995b4c78018bf430e5b03.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/diagnostics/QueryNestedFieldsByDot.md`

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (1)</summary>

<details>
<summary>docs/{en/,}diagnostics/**/*.md</summary>


**📄 CodeRabbit inference engine (.github/copilot-instructions.md)**

> `docs/{en/,}diagnostics/**/*.md`: Update diagnostic documentation in both Russian and English with examples of problematic code and fixes
> Document configuration parameters if applicable for diagnostics

Files:
- `docs/diagnostics/QueryNestedFieldsByDot.md`

</details>

</details><details>
<summary>🧠 Learnings (2)</summary>

<details>
<summary>📓 Common learnings</summary>

Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Update diagnostic documentation in both Russian and English with examples of problematic code and fixes


Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Document configuration parameters if applicable for diagnostics


</details>
<details>
<summary>📚 Learning: 2025-12-18T18:49:48.712Z</summary>

Learnt from: CR
Repo: 1c-syntax/bsl-language-server PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-18T18:49:48.712Z
Learning: Applies to docs/{en/,}diagnostics/**/*.md : Update diagnostic documentation in both Russian and English with examples of problematic code and fixes


**Applied to files:**
- `docs/diagnostics/QueryNestedFieldsByDot.md`

</details>

</details><details>
<summary>🪛 markdownlint-cli2 (0.18.1)</summary>

<details>
<summary>docs/diagnostics/QueryNestedFieldsByDot.md</summary>

18-18: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

19-19: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

20-20: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

25-25: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

26-26: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

27-27: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

28-28: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

29-29: Hard tabs
Column: 1

(MD010, no-hard-tabs)

---

38-38: Hard tabs
Column: 1

(MD010, no-hard-tabs)

</details>

</details>

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)</summary>

* GitHub Check: build
* GitHub Check: build (17, windows-latest)

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>docs/diagnostics/QueryNestedFieldsByDot.md (1)</summary><blockquote>

`11-44`: **Excellent work fixing the example numbering and formatting!**

The examples are now numbered sequentially (1, 2, 3, 4, 5), which resolves the previous concerns about missing examples 3 and 6. The conversion of inline code to fenced code blocks with the `bsl` language specifier significantly improves readability, and the hyperlink formatting in the Sources section is a nice touch.

</blockquote></details>

</blockquote></details>

<sub>✏️ Tip: You can disable this entire section by setting `review_details` to `false` in your review settings.</sub>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@sagittarius-s
Copy link
Contributor Author

Извиняюсь за невнимательность. Поправил.

@sonarqubecloud
Copy link

@nixel2007 nixel2007 merged commit f4137ab into 1c-syntax:develop Jan 16, 2026
25 checks passed
@nixel2007
Copy link
Member

Спасибо!

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.

2 participants