Harmonize FormHelper option-key docs to unquoted code spans#8312
Open
dereuromark wants to merge 2 commits into
Open
Harmonize FormHelper option-key docs to unquoted code spans#8312dereuromark wants to merge 2 commits into
dereuromark wants to merge 2 commits into
Conversation
Follow-up to the email page cleanup: the FormHelper options documentation wrote each option key as a quoted code span (`'type'`, `'url'`, ...). Drop the surrounding quotes so the keys render as `type`, `url`, ... matching the style used elsewhere in the docs. Only the option key being defined by each bullet is changed. Literal string values shown in the descriptions (`'get'`, `'post'`, `'reset'`, ...) keep their quotes, since those denote actual string literals passed by the user. Applied to both the English and Japanese pages so the key lists stay in sync.
The Japanese FormHelper page links to English-slug anchors (e.g. #general-control-options, #create-radio-button, #datetime-options) that the English page exposes via explicit <a id> tags and English heading slugs. The Japanese headings slugify differently, so none of these targets existed and 44 internal links were dangling. Add the matching explicit anchors before the corresponding Japanese sections. The two option groups #datetime-options and #time-options have no English counterpart; anchor them at the date- and time-related option subsections they are clearly meant to reference.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the recent email page cleanup (#8311).
The FormHelper options documentation wrote every option key as a quoted code span -
`'type'`,`'url'`,`'templates'`, etc. This page predates the convention used elsewhere in the docs, where option/config keys render unquoted:`type`,`url`,`templates`.This PR strips the surrounding quotes from the option key each bullet defines, on both the English and Japanese pages so the key lists stay in sync.
Scope / what is intentionally left untouched
Only the key being defined by a bullet is changed. Literal string values shown inside descriptions keep their quotes, because they denote actual strings the user passes:
So tokens like
`'get'`,`'post'`,`'reset'`,`'delete'`,`'both'`are deliberately preserved where they appear as values in running text.Grouped key bullets such as
`'rows', 'cols'`become`rows, cols`(quotes removed, single span kept).Anchor fix on the Japanese page
Touching the Japanese page made the link checker validate it and surface a pre-existing problem unrelated to the quotes: 44 internal links pointed at English-slug anchors (
#general-control-options,#create-radio-button,#checkbox-radio-select-options, ...) that only existed on the English page. The English page exposes them via explicit<a id>tags and English heading slugs; the Japanese headings slugify differently, so none of those targets existed.Added the matching explicit anchors before the corresponding Japanese sections, so all 44 links resolve.
#datetime-optionsand#time-optionshave no English counterpart and were anchored at the date- and time-related option subsections they clearly reference.No headings change, so there is no impact on links pointing into this page from elsewhere.