Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
17 Sep 2013 at 18:37 UTC
Updated:
29 Jul 2014 at 22:55 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
ifrikSee #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.
Comment #2
joverUpdated D8 deprecated url() to \Drupal::url().
Comment #3
petrpo commented<a href="@field-help">should be<a href="!field-help">according to D8 standards. Would it be possible to correct it in last patch?Comment #4
berkas1 commentedChanging to Needs work per #3
Comment #5
batigolixThis 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
Comment #6
batigolixI found there was a period missing.
Interdiff interdiffs between #2 and #6
Comment #7
batigolixRemoved some references to module that I copy-pasted from
Comment #8
jhodgdonUm. The patch in #7 is for options.module, not number.module? I'll wait to review until the right patch is uploaded.
Comment #9
batigolixOops: 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.
Comment #10
batigolixComment #11
jhodgdonThanks -- 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.
Comment #12
batigolixPatch addresses points in #11
Comment #13
jhodgdonFirst 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...
Comment #14
jhodgdonComment #15
batigolixFixed #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.
Comment #16
jhodgdonTagging for manual test, an excellent Novice task! Agreed the help is ready other than that.
Comment #17
jhodgdonI 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! :)
Comment #18
batigolixcomma fix
Comment #19
batigolixComment #20
jhodgdonThanks! This one is ready to go in.
Comment #21
jhodgdonThanks again everyone! Committed to 8.x.