Skip to content

Document fieldset formwidget#258

Open
mjauvin wants to merge 5 commits into
developfrom
document-fieldset
Open

Document fieldset formwidget#258
mjauvin wants to merge 5 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 for better discoverability.
    • Expanded Fieldset documentation with a new subsection (including a YAML example, notes about how values are submitted, and an options table for configuration).
    • Updated Nested Form documentation with a clarification on how nestedform field values are submitted.

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

coderabbitai Bot commented Feb 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7c3f8784-cf5e-4471-9cd5-35cdfca2cc5d

📥 Commits

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

📒 Files selected for processing (1)
  • backend/forms.md
✅ Files skipped from review due to trivial changes (1)
  • backend/forms.md

Walkthrough

Adds Fieldset documentation to backend/forms.md, including a Form Widgets navigation entry, a new Fieldset widget section with example and options, and a Nested Form note clarifying nested submission structure.

Changes

Cohort / File(s) Summary
Documentation – Form Widgets
backend/forms.md
Adds a Fieldset navigation link, introduces a new Fieldset widget documentation section with YAML example, note, and options table, and updates Nested Form documentation with a submission note.

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

🚥 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 matches the 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
🧪 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
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