Skip to content

Conversation

@fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 27, 2025

Summary by Sourcery

Improve documentation for template components and update component field configurations

Enhancements:

  • Update component field mappings to use HTMLFormField instead of TextFormField
  • Improve app configuration detection for djangocms_text plugin

Documentation:

  • Enhance documentation for template components tutorial, providing clearer guidance and explanations

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 27, 2025

Reviewer's Guide by Sourcery

This pull request includes updates to the djangocms_frontend component pool to use HTMLFormField and documentation improvements for clarity. The component pool change ensures compatibility with djangocms_text and the documentation changes improve the clarity of the template component tutorial.

Updated class diagram for CMSAutoComponentDiscovery

classDiagram
  class CMSAutoComponentDiscovery {
    default_field_context
  }

  note for CMSAutoComponentDiscovery.default_field_context "djangocms_text field updated to HTMLFormField"
Loading

File-Level Changes

Change Details Files
Updated the djangocms_text field type to HTMLFormField in default_field_context.
  • Changed djanghocms_text field type from djangocms_text.fields.TextFormField to djangocms_text.fields.HTMLFormField.
  • Ensured that inline editable fields are updated when djangocms_text is installed before djangocms_frontend.
djangocms_frontend/component_pool.py
Documentation improvements for clarity.
  • Updated the README.rst file.
  • Updated the index.rst file.
  • Updated the plugins/index.rst file.
  • Updated the reference.rst file.
  • Updated the tutorial/builtin_components.rst file.
  • Updated the tutorial/custom_components.rst file.
  • Updated the tutorial/index.rst file.
  • Updated the tutorial/template_components.rst file.
README.rst
docs/source/index.rst
docs/source/plugins/index.rst
docs/source/reference.rst
docs/source/tutorial/builtin_components.rst
docs/source/tutorial/custom_components.rst
docs/source/tutorial/index.rst
docs/source/tutorial/template_components.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We encountered an error and are unable to review this PR. We have been notified and are working to fix it.

You can try again by commenting this pull request with @sourcery-ai review, or contact us for help.

@codecov
Copy link

codecov bot commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.69%. Comparing base (8877c7a) to head (788098c).
Report is 19 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #267   +/-   ##
=======================================
  Coverage   88.69%   88.69%           
=======================================
  Files         124      124           
  Lines        3361     3361           
  Branches      283      283           
=======================================
  Hits         2981     2981           
  Misses        263      263           
  Partials      117      117           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fsbraun fsbraun merged commit e6ed81f into master Mar 27, 2025
35 checks passed
@fsbraun fsbraun deleted the chore/release-2-1 branch March 27, 2025 20:45
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