Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Доработана статья Flexberry Groupedit для 3 версии эмбера по замечаниям #221

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

BannikovRuslan
Copy link
Contributor

@BannikovRuslan BannikovRuslan commented Jul 19, 2024

Задача 42.

  1. fixedHeader - не внесены изменения, т.к. нужны уточнения по этой настройки. Будет вынесено в отдельную задачу.
  2. useSidePageMode - свойство удалено из описания, т.к. у групедита нет модальных окон.
  3. Решено не описывать приватные свойства.

Summary by CodeRabbit

  • Новые функции

    • Улучшена документация для компонента flexberry-groupedit, включая расширенные описания свойств и примеры использования.
    • Добавлены новые разделы о динамических обновлениях модели в groupedit, с примерами реализации.
  • Документация

    • Переписаны и уточнены описания свойств, включая рекомендации по мобильному использованию.
    • Улучшены инструкции по реализации пользовательских кнопок в панели инструментов.

Copy link

sonarcloud bot commented Jul 19, 2024

}
```

Реализацию примера можно посмотреть на [тестовом стенде](https://flexberry.github.io/ember-flexberry/dummy/dummy-test-2/#/components-examples/flexberry-groupedit/dynamic-groupedit).
Copy link
Contributor

Choose a reason for hiding this comment

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

Пустая строка в конце статьи

Copy link
Contributor

Choose a reason for hiding this comment

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

вроде так и надо?

Copy link
Contributor

Choose a reason for hiding this comment

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

ну в смысле она там есть

Copy link

sonarcloud bot commented Aug 27, 2024

Copy link

coderabbitai bot commented Oct 25, 2024

Walkthrough

Документ компонента flexberry-groupedit был изменён с целью улучшения ясности описаний, расширения документации свойств и улучшения структуры. Внесены изменения в разделы примеров использования, свойств и пользовательских кнопок, а также добавлены новые секции, касающиеся динамических обновлений модели в groupedit. Эти изменения направлены на упрощение понимания и реализации компонента для разработчиков.

Changes

Файл Изменения
pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md Обновлены описания, улучшена структура, добавлены новые секции, уточнены примеры использования и свойства.

Poem

В норе, где светит луна,
Изменения пришли, ура!
Компонент теперь ясен, как день,
Разработчик, не бойся, не лень!
Кнопки, свойства — всё в порядке,
Динамика в модели — в сладком зачатке! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 1

🧹 Outside diff range and nitpick comments (4)
pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md (4)

13-13: Улучшите описание компонента.

Предлагаю уточнить описание, добавив информацию о том, что компонент предназначен для работы с табличными данными:

-`flexberry-groupedit` – компонент на базе технологии Ember.js для работы с [детейлами](fo_detail-associations-properties.html) на форме редактирования.
+`flexberry-groupedit` – табличный компонент на базе технологии Ember.js для работы с [детейлами](fo_detail-associations-properties.html) на форме редактирования.

59-60: Исправьте форматирование таблицы свойств.

Между заголовком таблицы и содержимым отсутствует пустая строка, что нарушает правила оформления Markdown.

Свойство | Краткое описание
:--------|:----------------
+
`defaultSettingsButton`| Флаг, определяющий, будет ли показана кнопка настроек по умолчанию на панели инструментов. Значение по умолчанию: true. Нажатие кнопки применит настройки отображение табличных данных, заданные по умолчанию `DEFAULT` и определяющие ширину столбцов, их отображение и порядок сортировки. 
🧰 Tools
🪛 Markdownlint

59-59: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


326-342: Улучшите структуру раздела о пользовательских кнопках.

Текст содержит избыточные повторы и может быть структурирован более эффективно.

-EditFormController - расширяет стандартный контроллер формы редактирования и позволяет создавать пользовательские кнопки для панели управления groupedit.

-Для создания пользовательских кнопок на панели управления groupedit нужно:

-В шаблоне для компонента groupedit задать значение свойства `customButtons` и события для создаваемых кнопок.

+### Создание пользовательских кнопок
+
+Для добавления пользовательских кнопок на панель управления groupedit необходимо:
+
+1. В шаблоне компонента задать значение свойства `customButtons`
+2. Определить обработчики событий для создаваемых кнопок

568-607: Исправьте форматирование последних разделов.

В конце документа нарушено форматирование:

  • Отсутствуют пустые строки между заголовками и содержимым
  • Неконсистентное использование пустых строк
## Ordered свойства в groupedit
+

При добавлении в представление, groupedit ordered-свойства в нем появятся некоторые особенности, которые следует учитывать:

...

## Динамическое обновление модели в groupedit
+

Существует возможность реализации динамического изменения groupedit в зависимости, например, от выбранного значения в object-list-view, расположенного на той же форме, что и groupedit.
🧰 Tools
🪛 Markdownlint

575-575: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a12eaf2 and cfe17e1.

📒 Files selected for processing (1)
  • pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md (10 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md

[uncategorized] ~61-~61: Избыточные определения. В правильно составленном предложении не должно быть больше одного придаточного определения.
Context: ...tFormRoute`| Роут формы редактирования, который будет открыт после клика по соответствующей строке (именно тот, по которому был клик). **Дополнительные свойства:*...

(OPREDELENIA)


[uncategorized] ~65-~65: Перед знаками препинания не должно быть пробела: «описание:»
Context: ...тельные свойства:** Свойство | Краткое описание :--------|:---------------- `editOnSepara...

(Punct_and_spaces)

🪛 Markdownlint
pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md

59-59: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


208-208: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


412-412: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


575-575: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

@@ -449,8 +499,7 @@ console.log(cellComponent); // Выведет объект с настройка
Настройка данного варианта аналогичная описываемому выше способу. В шаблоне контрола при этом нужно выставить один дополнительный флаг `saveBeforeRouteLeave`.

```hbs
{% raw %}
{{flexberry-groupedit
{% raw %}{{flexberry-groupedit
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

⚠️ Potential issue

Требуется обновление ссылок в документации

В файле найдены следующие проблемы с ссылками:

  • Ссылка на fo_detail-associations-properties.html указывает на устаревшую документацию
  • Ссылка на efd3_template.html некорректна, соответствующий файл отсутствует в директории 3.x
  • Некоторые ссылки на Ember.js guides указывают на устаревшие версии (v3.1.0, v3.12.0)
  • Ссылки на GitHub репозиторий должны указывать на актуальную ветку

Необходимо:

  1. Обновить ссылки на документацию Flexberry на актуальные версии для 3.x
  2. Обновить ссылки на Ember.js guides до актуальной версии
  3. Проверить и обновить ссылки на GitHub репозиторий
🔗 Analysis chain

Обновите ссылки на документацию.

Ссылки на статьи должны вести на актуальную версию документации для Ember 3.x.


Let me check the actual links in the specific file to verify if they need updating.


Let me check if these links are pointing to the correct 3.x documentation versions by checking if the referenced files exist in the 3.x directory.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find all markdown links in the documentation
rg -l "\[.*\]\(.*\)" pages/products/flexberry-ember/

Length of output: 10083


Script:

#!/bin/bash
# Check all markdown links in the groupedit documentation file
rg "\[.*\]\(.*\)" pages/products/flexberry-ember/3.x/components/ef3_groupedit.ru.md

Length of output: 6208


Script:

#!/bin/bash
# Check existence of referenced files in 3.x directory
fd "editform.ru.md|template.ru.md|router.ru.md|model.ru.md|serializer.ru.md" pages/products/flexberry-ember/3.x/

Length of output: 397

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

Successfully merging this pull request may close these issues.

3 participants