Document fieldset formwidget by mjauvin · Pull Request #258 · wintercms/docs

mjauvin · 2026-02-20T16:45:25Z

Summary by CodeRabbit

Documentation
- Added comprehensive Fieldset documentation across the form widgets and date picker sections, including YAML examples, explanatory notes on visual grouping, and an options table describing configuration.
- Added Fieldset to the form widgets navigation to improve discoverability and ensured consistent content in all related sections.

coderabbitai · 2026-02-20T16:45:47Z

Walkthrough

Adds Fieldset documentation to backend/forms.md: introduces a Fieldset widget entry (YAML examples, notes, options table), inserts Fieldset into the Form Widgets navigation, and duplicates the Fieldset documentation within the Date picker / Form widgets sections for consistency.

Changes

Cohort / File(s)	Summary
Documentation – Fieldset Widget `backend/forms.md`	Adds a new Fieldset widget documentation block with YAML configuration examples, descriptive notes, and an options table. Inserts Fieldset into the Form Widgets top navigation list and duplicates the Fieldset section under the Date picker/Form widgets area for consistency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Document fieldset formwidget' directly reflects the main change—adding documentation for the fieldset form widget to backend/forms.md.
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.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch document-fieldset

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

coderabbitai

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.

backend/forms.md

LukeTowers · 2026-02-20T16:51:07Z

backend/forms.md

+
+`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.


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

backend/forms.md

coderabbitai

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.

coderabbitai · 2026-02-20T16:57:03Z

backend/forms.md

+                type: url
+```
+
+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.


⚠️ Potential issue | 🟡 Minor

Fix grammatical error.

The phrase "for grouping purpose" should use the plural form "purposes".

📝 Proposed fix

-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 purposes.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

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 purposes.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@backend/forms.md` at 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.

Document fieldset formwidget

fe83669

mjauvin self-assigned this Feb 20, 2026

mjauvin mentioned this pull request Feb 20, 2026

Add fieldset formwidget wintercms/winter#1435

Draft

coderabbitai bot reviewed Feb 20, 2026

View reviewed changes

backend/forms.md Outdated Show resolved Hide resolved

LukeTowers reviewed Feb 20, 2026

View reviewed changes

backend/forms.md Outdated Show resolved Hide resolved

Apply suggestion from @LukeTowers

227f594

LukeTowers reviewed Feb 20, 2026

View reviewed changes

backend/forms.md Outdated Show resolved Hide resolved

Apply suggestion from @LukeTowers

b91af19

coderabbitai bot reviewed Feb 20, 2026

View reviewed changes

add precisions for both fieldset/nestedform POST data behavior

018812d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Comments

Document fieldset formwidget#258

Document fieldset formwidget#258
mjauvin wants to merge 4 commits intodevelopfrom
document-fieldset

mjauvin commented Feb 20, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 20, 2026 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

LukeTowers Feb 20, 2026

Uh oh!

mjauvin Feb 20, 2026

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		`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.

	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 purposes.

Uh oh!

Comments

Conversation

mjauvin commented Feb 20, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LukeTowers Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

mjauvin Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mjauvin commented Feb 20, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 20, 2026 •

edited

Loading