Background:
This issue is part of the task to update the hook_help texts of the Drupal 8 modules:
#1908570: [meta] Update or create hook_help() texts for D8 core modules

Tasks:
- review / write the hook_help text according to help guidelines

Files: 
CommentFileSizeAuthor
#18 8.x-number_hook_help_update-2091345-18.patch2.46 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 63,676 pass(es).
[ View ]
#15 8.x-number_hook_help_update-2091345-15.patch2.46 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 63,183 pass(es).
[ View ]
#12 8.x-number_hook_help_update-2091345-12.patch2.46 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 63,012 pass(es).
[ View ]
#12 interdiff.txt2.73 KBbatigolix
#6 interdiff.txt2.4 KBbatigolix
#6 8.x-number_hook_help_update-2091345-6.patch2.44 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 59,899 pass(es).
[ View ]
#5 8.x-number_hook_help_update-2091345-5.patch2.44 KBbatigolix
PASSED: [[SimpleTest]]: [MySQL] 60,027 pass(es).
[ View ]
#5 interdiff.txt2.4 KBbatigolix
#2 8.x-number_hook_help_update-2091345-2.patch1.34 KBjover
PASSED: [[SimpleTest]]: [MySQL] 58,575 pass(es).
[ View ]

Comments

ifrik’s picture

See #2030569: [policy] Decide how to refer to "entities" and "bundles" in D8 UI
and the help text for Link module #2028799: Improve help for link module, for the default wording of modules that provide fields for fieldable entities.

About
The Foo module allows you to create fields that contain [something]. See the <a href="!field">Field module help</a> and the <a href="!field_ui">Field UI help</a> pages for general information on fields and how to create and manage them.
jover’s picture

Status:Active» Needs review
StatusFileSize
new1.34 KB
PASSED: [[SimpleTest]]: [MySQL] 58,575 pass(es).
[ View ]

Updated D8 deprecated url() to \Drupal::url().

petrpo’s picture

<a href="@field-help"> should be <a href="!field-help"> according to D8 standards. Would it be possible to correct it in last patch?

berkas1’s picture

Status:Needs review» Needs work

Changing to Needs work per #3

batigolix’s picture

Component:documentation» number.module
Issue summary:View changes
Status:Needs work» Needs review
Parent issue:» #1908570: [meta] Update or create hook_help() texts for D8 core modules
Related issues:+#2028799: Improve help for link module
StatusFileSize
new2.4 KB
new2.44 KB
PASSED: [[SimpleTest]]: [MySQL] 60,027 pass(es).
[ View ]

This patch rewrites the hook_help to become more similar to the one for Link module.

It adds a section that explains the 3 number field types.

It drops the sentences "Number fields can be limited to a specific set of input values or to a range of values.". It is true but not really clear. It is just some of the specific field settings (comparable to field size restrictions settings in file fields) that do not really need to be mentioned, I think

Also assigning to component number.module in case we need maintainer feedback

batigolix’s picture

StatusFileSize
new2.44 KB
PASSED: [[SimpleTest]]: [MySQL] 59,899 pass(es).
[ View ]
new2.4 KB

I found there was a period missing.

Interdiff interdiffs between #2 and #6

batigolix’s picture

StatusFileSize
new1.9 KB
PASSED: [[SimpleTest]]: [MySQL] 60,047 pass(es).
[ View ]

Removed some references to module that I copy-pasted from

jhodgdon’s picture

Status:Needs review» Needs work

Um. The patch in #7 is for options.module, not number.module? I'll wait to review until the right patch is uploaded.

batigolix’s picture

Oops: working on too many issues at the same time withj too many tabs open.

Please review the patch in #6.

I'll hide the wrong patch.

batigolix’s picture

Status:Needs work» Needs review
jhodgdon’s picture

Status:Needs review» Needs work

Thanks -- looks mostly good! A few typographical-level mistakes:

a) This help text still says "link field" in a couple of places. It should instead use the name of the field that a user would see in this module.

There appear to be three:
Number (decimal)
Number (float)
Number (integer)

Since there are three, probably this help should say "number fields" instead of "link field"?

b) There is a list of the field types and it needs comma before "or" (in the second Uses item).

c)
"The decimal number field type allow users to enter exact decimal values. "
allow -> allows

d) e.g. means "for example", and it always needs to be followed by a comma. But it's even better just to use the words "for example", as e.g. is often misunderstood.

batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new2.73 KB
new2.46 KB
PASSED: [[SimpleTest]]: [MySQL] 63,012 pass(es).
[ View ]

Patch addresses points in #11

jhodgdon’s picture

First sentence of About:

...allows you to create fields that contain various numeric field types.

Would this be better as "that contain various types of numeric data"? I'm not sure, but it just seems a bit weird to say that fields contain field types?

Other than that, I think this is ready for a manual test...

jhodgdon’s picture

Status:Needs review» Needs work
batigolix’s picture

Status:Needs work» Needs review
StatusFileSize
new2.46 KB
PASSED: [[SimpleTest]]: [MySQL] 63,183 pass(es).
[ View ]

Fixed #13.

Ready for a manual test:

- Verify that all the links work
- Verify that all mentions of pages/text within the UI match what is seen in the UI
- Verify that the formatting is OK.

jhodgdon’s picture

Tagging for manual test, an excellent Novice task! Agreed the help is ready other than that.

jhodgdon’s picture

Status:Needs review» Needs work

I gave this a manual test today and it all looks good except for one typo:

decimal, float or, integer.

should be

decimal, float, or integer.

Whoops! :)

batigolix’s picture

StatusFileSize
new2.46 KB
PASSED: [[SimpleTest]]: [MySQL] 63,676 pass(es).
[ View ]

comma fix

batigolix’s picture

Status:Needs work» Needs review
jhodgdon’s picture

Component:number.module» documentation
Status:Needs review» Reviewed & tested by the community

Thanks! This one is ready to go in.

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed

Thanks again everyone! Committed to 8.x.

Status:Fixed» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.