Skip to content

Conversation

@AncientNimbus
Copy link
Contributor

Because

A pluralization issue is found in the Form Basics learning material. Since the submit type button creates a single button similar to reset and generic, the sub-heading for submit button should be singular.

This PR

Update sub-header text to use singular “button” instead of “buttons”

Issue

Closes #XXXXX

Additional Information

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

Correct the pluralization for the Submit button sub-heading.
@github-actions github-actions bot added the Content: Intermediate HTML/CSS Involves the Intermediate HTML/CSS course label Aug 11, 2025
@AncientNimbus AncientNimbus marked this pull request as ready for review August 11, 2025 17:21
@mao-sz
Copy link
Contributor

mao-sz commented Aug 11, 2025

IMO, Submit buttons makes more sense grammatically because the heading is for a section talking about submit buttons in general. The heading isn't referring to any individual submit button specifically.

The submit button makes grammatical sense but forms are also not limited to a single submit button. It's perfectly valid to use multiple submit buttons for a single form.

@AncientNimbus
Copy link
Contributor Author

IMO, Submit buttons makes more sense grammatically because the heading is for a section talking about submit buttons in general. The heading isn't referring to any individual submit button specifically.

The submit button makes grammatical sense but forms are also not limited to a single submit button. It's perfectly valid to use multiple submit buttons for a single form.

You are right about that, but I submit the correction mainly due to the context of the paragraph.

Initially, when I first read the heading I thought there are different types of submit button, but there is just one type.

Also, "The submit button" is used throughout the explanation, the content focuses on the general concept of the button type.

I hope this clarify my intent here :)

@mao-sz
Copy link
Contributor

mao-sz commented Aug 11, 2025

Submit button as a heading wouldn't make sense though, since headings typically should be able to be read like The following section is about <heading> e.g. The following section is about submit buttons or The following section is about the submit button, but not The following section is about submit button.

Although in this case you misinterpreted "submit buttons" as "multiple types of submit buttons", I wouldn't say it's obviously ambiguous, in the same way a section heading called Divs or Spans could technically be interpreted as there being multiple types of divs or spans, but I'd imagine in most cases the more common interpretation would be talking about divs and spans in general.

@AncientNimbus
Copy link
Contributor Author

AncientNimbus commented Aug 11, 2025

Since this is more or less a stylistic choice, and not a real bug I shall rest my case after we consider this one last aspect:

Perhaps it is worth considering MDN's reference for the sake of consistency.

I mainly find it odd when reading the current learning material, the headers for button type reset and generic are both singular, while button type submit is plural, even though each section is primarily an explanation of the given type. The change here seems to improve the clarity of the subject. In any case, I am happy either way.

I hope this make sense, thank you. :)

@mao-sz
Copy link
Contributor

mao-sz commented Aug 11, 2025

This is only my opinion I'm offering, and a maint may well hold a different one.

Looking at the rest of the headings, I actually feel instead of changing this one to singular, the other ones should be changed to plural or all changed to The <type> button

Personally, Submit button, Reset button and Generic button don't read as sensibly in the context of the lesson flow. Though that is of course nitpicking. Agreed on the consistency issue though, I don't like how one is one way and the others are different.

Edit: Looking at other headings outside of the buttons part, there are plenty others also inconsistent, like Placeholder attribute then The type attribute, or Text area but Labels. I don't like this inconsistency and would suggest maints consider if the rest of these headings could also be tidied up with some consistency between them. Plural and The <singular> work well together because they can be read as Let's talk about <heading> but just <singular> can't and seems jarring when mixed with the others IMHO.

@AncientNimbus
Copy link
Contributor Author

Agreed on the consistency issue though, I don't like how one is one way and the others are different.

Yeah, that's the reason for the PR, as it is somewhat noticeable. Either way will work so long the clarity is established and it supports the lesson's flow.

type : The Button element - HTML | MDN

I think this is a better reference as it is a direct mirror to the subject.

@wise-king-sullyman wise-king-sullyman requested review from a team and xandora and removed request for a team August 12, 2025 20:22
@mao-sz
Copy link
Contributor

mao-sz commented Sep 3, 2025

@AncientNimbus
Am maint again - let's go with the 3 button subsection headings being pluralised, which should be the least work needing done to make the lesson consistent.

@AncientNimbus
Copy link
Contributor Author

@AncientNimbus Am maint again - let's go with the 3 button subsection headings being pluralised, which should be the least work needing done to make the lesson consistent.

Thanks for the ping, I have update the file accordingly, and it is ready for review.

Copy link
Contributor

@mao-sz mao-sz left a comment

Choose a reason for hiding this comment

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

Many thanks!
We now have a new style guide rule that all note boxes must have a level 4 heading. Would you be happy to add a relevant one for the note box that the linter is pointing out? Details are in markdownlint/docs/TOP012.md

If not, let me know and I'm happy to merge the PR as it is.

@AncientNimbus
Copy link
Contributor Author

Many thanks! We now have a new style guide rule that all note boxes must have a level 4 heading. Would you be happy to add a relevant one for the note box that the linter is pointing out?

If not, let me know and I'm happy to merge the PR as it is.

Yes, I am happy to apply the fix, reviewing the lint requirement now.

Clarify the importance of specifying button types in forms to prevent unintended submissions.
Address TOP012 error.
@AncientNimbus AncientNimbus requested a review from mao-sz September 3, 2025 19:42
Copy link
Contributor

@mao-sz mao-sz left a comment

Choose a reason for hiding this comment

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

🙏

@mao-sz mao-sz merged commit 3342bf1 into TheOdinProject:main Sep 3, 2025
2 checks passed
@AncientNimbus AncientNimbus deleted the patch-1 branch September 3, 2025 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content: Intermediate HTML/CSS Involves the Intermediate HTML/CSS course

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants