Skip to content

Fix misleading comment in README about browser_validations default#1869

Closed
55728 wants to merge 1 commit into
heartcombo:mainfrom
55728:fix-readme-browser-validations-comment
Closed

Fix misleading comment in README about browser_validations default#1869
55728 wants to merge 1 commit into
heartcombo:mainfrom
55728:fix-readme-browser-validations-comment

Conversation

@55728

@55728 55728 commented Apr 20, 2026

Copy link
Copy Markdown

The README contains a code example with a comment stating # default is true:

SimpleForm.browser_validations = false # default is true

While true is the default in lib/simple_form.rb, the generator intentionally sets it to false in the initializer (see #319). This has caused recurring confusion, as reported in #1216 and #1746.

This PR removes the misleading inline comment so that users are not led to believe their app is running with browser_validations = true after running the generator.

Fixes #1746

@55728

55728 commented Jun 5, 2026

Copy link
Copy Markdown
Author

Closing this as stale. Happy to reopen if needed. Thanks!

@55728 55728 closed this Jun 5, 2026
@55728 55728 deleted the fix-readme-browser-validations-comment branch June 5, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

README.md says browser_validations = true by default, but generator makes it false

1 participant