Skip to content

Document fieldset formwidget - #258

Merged
LukeTowers merged 7 commits into
developfrom
document-fieldset
Aug 19, 2026
Merged

Document fieldset formwidget#258
LukeTowers merged 7 commits into
developfrom
document-fieldset

Conversation

@mjauvin

@mjauvin mjauvin commented Feb 20, 2026

Copy link
Copy Markdown
Member

Related to: wintercms/winter#1435

Summary by CodeRabbit

  • Documentation
    • Added Fieldset to the form widgets navigation.
    • Documented Fieldset configuration, grouped-field YAML, legend behavior, and flat parent-form submission.
    • Clarified when to use Fieldset versus Nested Form based on the data structure.
    • Documented that Nested Form values are submitted under a nested array named after the field.

@mjauvin mjauvin self-assigned this Feb 20, 2026
@coderabbitai

coderabbitai Bot commented Feb 20, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@LukeTowers, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

Wait for the limit to reset, then comment @coderabbitai review or push new commits to the PR.

An organization admin can change what happens after included review limits in Billing.

How do review limits work?

CodeRabbit enforces per-developer PR review limits within each organization.

For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8f6182f8-e246-407d-94f9-3d480853e5df

📥 Commits

Reviewing files that changed from the base of the PR and between 39c591d and 671d1f0.

📒 Files selected for processing (1)
  • backend/forms.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9ff2d219-297b-4bf9-afa0-43691a13636d

📥 Commits

Reviewing files that changed from the base of the PR and between a9062c8 and 39c591d.

📒 Files selected for processing (1)
  • backend/forms.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

Adds Fieldset documentation to backend/forms.md. The update adds a Form Widgets navigation entry, documents Fieldset grouping, YAML configuration, legend rendering, flat model storage, and the fields option. It also compares Fieldset with nestedform and clarifies nested submission structure.

Changes

Cohort / File(s) Summary
Documentation – Form Widgets
backend/forms.md
Adds Fieldset documentation and updates Nested Form documentation with flat and nested submission details.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 39c59

This documentation-only change introduces no actionable merge-blocking risk and is merge-ready after normal checks and review.

🚥 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 title clearly and concisely describes the pull request's main change: documenting the fieldset form widget.
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.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch document-fieldset

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
backend/forms.md (1)

1031-1031: Consider using standard double asterisks for emphasis.

The triple asterisks (***visually***) will render as bold italic, which is somewhat unusual. Consider using double asterisks for standard bold emphasis to maintain consistency with common markdown conventions.

📝 Suggested change
-A fieldset provides a way of ***visually*** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purpose.
+A fieldset provides a way of **visually** grouping fields. The form definition does not support tabs or secondary tabs as it is only used to define the fields for grouping purpose.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@backend/forms.md` at line 1031, Replace the unusual bold-italic emphasis by
changing the triple asterisks around "visually" to standard double asterisks in
the sentence "A fieldset provides a way of ***visually*** grouping fields."
(i.e., update "***visually***" to "**visually**") so the text uses consistent
Markdown bold formatting in backend/forms.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@backend/forms.md`:
- Around line 1009-1011: The documentation line describing fieldset should
escape the HTML element name by wrapping the <fieldset> tags in backticks;
update the text around the `fieldset` entry so both occurrences of <fieldset>
are written as code literals (e.g., `<fieldset>`) to match the file's existing
pattern for HTML elements and avoid rendering them as real HTML in the docs.

---

Nitpick comments:
In `@backend/forms.md`:
- Line 1031: Replace the unusual bold-italic emphasis by changing the triple
asterisks around "visually" to standard double asterisks in the sentence "A
fieldset provides a way of ***visually*** grouping fields." (i.e., update
"***visually***" to "**visually**") so the text uses consistent Markdown bold
formatting in backend/forms.md.

Comment thread backend/forms.md Outdated
Comment thread backend/forms.md Outdated
Comment thread backend/forms.md Outdated

`fieldset` - renders a group of fields in a <fieldset> tag.

> **NOTE:** Contrary to the [nestedform](#nested-form), the fields defined in a fieldset are part of the main form. They are only grouped visually within the `<fieldset>` tag.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@mjauvin can you add a similar note to the nestedform section

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done

Comment thread backend/forms.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
backend/forms.md (1)

1011-1011: Use consistent link text that matches the section title.

The link text "nestedform" should match the actual section title "Nested Form" for consistency with other cross-references in the documentation.

📝 Proposed fix
-> **NOTE:** Contrary to the [nestedform](`#nested-form`), the fields defined in a fieldset are part of the main form. They are only grouped visually within the `<fieldset>` tag.
+> **NOTE:** Contrary to the [Nested Form](`#nested-form`), the fields defined in a fieldset are part of the main form. They are only grouped visually within the `<fieldset>` tag.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@backend/forms.md` at line 1011, Update the cross-reference link text so it
matches the section title: replace the markdown link text
"[nestedform](`#nested-form`)" with "[Nested Form](`#nested-form`)" in the sentence
shown (the anchor "#nested-form" stays unchanged) so the visible link matches
the "Nested Form" section title.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@backend/forms.md`:
- Line 1031: Fix the grammar in the sentence inside the form description by
changing the phrase "for grouping purpose" to "for grouping purposes" so the
sentence reads that the form definition is only used to define the fields for
grouping purposes; locate this text in the form description string (the sentence
starting "The form definition does not support tabs or secondary tabs as it is
only used to define the fields for grouping...") and update the plural.

---

Nitpick comments:
In `@backend/forms.md`:
- Line 1011: Update the cross-reference link text so it matches the section
title: replace the markdown link text "[nestedform](`#nested-form`)" with "[Nested
Form](`#nested-form`)" in the sentence shown (the anchor "#nested-form" stays
unchanged) so the visible link matches the "Nested Form" section title.

Comment thread backend/forms.md Outdated
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@LukeTowers
LukeTowers merged commit 5fc1834 into develop Aug 19, 2026
2 checks passed
@LukeTowers
LukeTowers deleted the document-fieldset branch August 19, 2026 21:56
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