Skip to content

📝 Add docstrings to feature/updCommonLib#525

Closed
coderabbitai[bot] wants to merge 7 commits into
developfrom
coderabbitai/docstrings/67d2fa5
Closed

📝 Add docstrings to feature/updCommonLib#525
coderabbitai[bot] wants to merge 7 commits into
developfrom
coderabbitai/docstrings/67d2fa5

Conversation

@coderabbitai

@coderabbitai coderabbitai Bot commented Oct 6, 2025

Copy link
Copy Markdown

Docstrings generation was requested by @theshadowco.

The following files were modified:

  • src/main/java/com/github/_1c_syntax/bsl/mdclasses/CF.java
  • src/main/java/com/github/_1c_syntax/bsl/mdclasses/MDClasses.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/Catalog.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/ChartOfCharacteristicTypes.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/Enum.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/Language.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/storage/form/FormElementType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/ApplicationRunMode.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/AutoRecordType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/ConfigurationExtensionPurpose.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataLockControlMode.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataSeparation.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataSetType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/FormType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/Handler.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/IndexingType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/InterfaceCompatibilityMode.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/MessageDirection.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/ObjectBelonging.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/ReturnValueReuse.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/ReuseSessions.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/RoleRight.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/TemplateType.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/TransferDirection.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/UseMode.java
  • src/main/java/com/github/_1c_syntax/bsl/mdo/support/UsePurposes.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/context/MDCReaderContext.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/DataSetConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/EnumConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/SubsystemConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeDescriptionConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeQualifierConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/designer/DesignerReader.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/FormElementConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/MDChildConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/TemplateConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/edt/EDTReader.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/ExternalDataSourceTableConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/FormItemConverter.java
  • src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/ObjectTemplateConverter.java
  • src/test/java/com/github/_1c_syntax/bsl/test_utils/MDTestUtils.java
These files were ignored
  • src/test/java/com/github/_1c_syntax/bsl/examples/ValueTypeTest.java
  • src/test/java/com/github/_1c_syntax/bsl/mdclasses/ExternalReportTest.java
  • src/test/java/com/github/_1c_syntax/bsl/mdo/EnumTest.java
  • src/test/java/com/github/_1c_syntax/bsl/mdo/LanguageTest.java
  • src/test/java/com/github/_1c_syntax/bsl/mdo/support/ApplicationRunModeTest.java
  • src/test/java/com/github/_1c_syntax/bsl/mdo/support/InterfaceCompatibilityModeTest.java
These file types are not supported
  • docs/ru/examples.md
ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

theshadowco and others added 7 commits October 6, 2025 16:23
@theshadowco
1. использование новой версии common library
ea2f232 
2. доработано хранение типов значений, часть классов уехала в common lib
3. все перечисления переведены на хранение двух языков имени
4. для catalog добавлено хранение владельцев
@theshadowco
убрал тестовую строку
e20d12d
@theshadowco
fix potencial npe
f02b0f0
@theshadowco
sq fixes
80b0cd8
@theshadowco
sq fix
5a50594
@theshadowco
sq & javadoc fixes
67d2fa5
@coderabbitai
📝 Add docstrings to feature/updCommonLib
5bece3e 
Docstrings generation was requested by @theshadowco.

* #524 (comment)

The following files were modified:

* `src/main/java/com/github/_1c_syntax/bsl/mdclasses/CF.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdclasses/MDClasses.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/Catalog.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/ChartOfCharacteristicTypes.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/Enum.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/Language.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/storage/form/FormElementType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/ApplicationRunMode.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/AutoRecordType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/ConfigurationExtensionPurpose.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataLockControlMode.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataSeparation.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/DataSetType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/FormType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/Handler.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/IndexingType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/InterfaceCompatibilityMode.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/MessageDirection.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/ObjectBelonging.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/ReturnValueReuse.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/ReuseSessions.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/RoleRight.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/TemplateType.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/TransferDirection.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/UseMode.java`
* `src/main/java/com/github/_1c_syntax/bsl/mdo/support/UsePurposes.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/context/MDCReaderContext.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/DataSetConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/EnumConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/SubsystemConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeDescriptionConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/converter/ValueTypeQualifierConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/common/xstream/ExtendXStream.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/designer/DesignerReader.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/FormElementConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/MDChildConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/designer/converter/TemplateConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/edt/EDTReader.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/ExternalDataSourceTableConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/FormItemConverter.java`
* `src/main/java/com/github/_1c_syntax/bsl/reader/edt/converter/ObjectTemplateConverter.java`
* `src/test/java/com/github/_1c_syntax/bsl/test_utils/MDTestUtils.java`
@coderabbitai
coderabbitai Bot requested a review from theshadowco October 6, 2025 15:20
@coderabbitai coderabbitai Bot mentioned this pull request Oct 6, 2025
Merged
4 tasks
@coderabbitai

coderabbitai Bot commented Oct 6, 2025

Copy link
Copy Markdown
Author

Important

Review skipped

CodeRabbit bot authored PR detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

@sonarqubecloud

sonarqubecloud Bot commented Oct 6, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
2.5% Duplication on New Code

See analysis details on SonarQube Cloud

@github-actions

github-actions Bot commented Oct 6, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Test Results

  522 files  ±0    522 suites  ±0   7m 3s ⏱️ +8s
  221 tests ±0    221 ✅ ±0  0 💤 ±0  0 ❌ ±0 
2 007 runs  ±0  2 007 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 5bece3e. ± Comparison against base commit 67d2fa5.

♻️ This comment has been updated with latest results.

Base automatically changed from feature/updCommonLib to develop October 6, 2025 15:39
@theshadowco

theshadowco commented Oct 6, 2025

Copy link
Copy Markdown
Member

@CodeRabbit

  1. выполни rebase
  2. javadoc должен быть на русском языке
  3. каждый изменный файл должен иметь пустую строку в конце

@coderabbitai

coderabbitai Bot commented Oct 6, 2025

Copy link
Copy Markdown
Author

Tip

For best results, initiate chat on the files or code changes.

@theshadowco, спасибо за обратную связь! К сожалению, я не могу выполнить эти изменения по следующим причинам:

  1. Rebase: Я не могу выполнять Git операции, которые изменяют репозиторий напрямую, включая rebase. Вам нужно будет выполнить rebase вручную.

  2. Javadoc на русском языке: Я понимаю требование, но не могу редактировать свои собственные pull request'ы.

  3. Пустая строка в конце файла: Также не могу применить это форматирование к текущему PR.

Рекомендуемые действия:

  • Закрыть этот PR
  • Я создам новый PR с правильными требованиями (javadoc на русском и пустая строка в конце каждого файла)
  • Вы сможете выполнить rebase на новом PR при необходимости

Хотите, чтобы я закрыл этот PR и создал новый с правильными требованиями?

✏️ Learnings added 
Learnt from: theshadowco
URL: https://github.com/1c-syntax/mdclasses/pull/525

Timestamp: 2025-10-06T15:45:27.762Z
Learning: For the mdclasses repository, all Javadoc comments in Java files must be written in Russian language (ru-RU), not English.

Learnt from: theshadowco
URL: https://github.com/1c-syntax/mdclasses/pull/525

Timestamp: 2025-10-06T15:45:27.762Z
Learning: For the mdclasses repository, each Java source file must end with an empty line.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@theshadowco

theshadowco commented Oct 6, 2025

Copy link
Copy Markdown
Member

@CodeRabbit

я согласен с твоим предложением #525 (comment).
Создавай новый реквест с учетом всех замечаний, этот я закрою после создания нового

@coderabbitai

coderabbitai Bot commented Oct 6, 2025

Copy link
Copy Markdown
Author

Tip

For best results, initiate chat on the files or code changes.

@theshadowco, прошу прощения за недопонимание в моём предыдущем сообщении. К сожалению, я не могу создавать pull request'ы или коммитить код в репозиторий напрямую, даже если это мои собственные PR.

Вот что я могу сделать вместо этого:

  1. Помочь вам создать новый PR вручную: Я могу предоставить вам полный список изменений, которые нужно внести:

    • Переписать все Javadoc комментарии на русский язык
    • Добавить пустую строку в конец каждого изменённого файла

  2. Проверить новый PR: Когда вы или кто-то другой создаст новый PR с этими изменениями, я смогу его проверить и убедиться, что все требования выполнены.

Альтернативные варианты:

  • Вы можете вручную внести необходимые изменения в этот PR (переписать javadoc на русский, добавить пустые строки)
  • Или кто-то из команды может создать новый PR с правильными требованиями

Как бы вы хотели продолжить?

@theshadowco theshadowco closed this Oct 6, 2025
@theshadowco
theshadowco deleted the coderabbitai/docstrings/67d2fa5 branch October 6, 2025 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@theshadowco theshadowco Awaiting requested review from theshadowco

Assignees

@theshadowco theshadowco

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@theshadowco