Tryton Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(137)

Issue 44551003: trytond: Add help texts.

Can't Edit
Can't Publish+Mail
Start Review
Created:
4 weeks, 1 day ago by udono
Modified:
1 week, 6 days ago
Reviewers:
pokoli, reviewbot
Visibility:
Public.

Description

Patch Set 1 #

Total comments: 27
Unified diffs Side-by-side diffs Delta from patch set Stats (+581 lines, -320 lines) Patch
M trytond/ir/action.py View 8 chunks +79 lines, -44 lines 20 comments Download
M trytond/ir/attachment.py View 1 chunk +15 lines, -8 lines 4 comments Download
M trytond/ir/cron.py View 1 chunk +21 lines, -14 lines 2 comments Download
M trytond/ir/export.py View 1 chunk +6 lines, -4 lines 1 comment Download
M trytond/ir/lang.py View 1 chunk +61 lines, -23 lines 0 comments Download
M trytond/ir/model.py View 9 chunks +90 lines, -54 lines 0 comments Download
M trytond/ir/module.py View 5 chunks +24 lines, -11 lines 0 comments Download
M trytond/ir/note.py View 1 chunk +5 lines, -3 lines 0 comments Download
M trytond/ir/resource.py View 1 chunk +3 lines, -3 lines 0 comments Download
M trytond/ir/rule.py View 2 chunks +18 lines, -11 lines 0 comments Download
M trytond/ir/sequence.py View 1 chunk +27 lines, -14 lines 0 comments Download
M trytond/ir/translation.py View 4 chunks +28 lines, -13 lines 0 comments Download
M trytond/ir/trigger.py View 1 chunk +24 lines, -16 lines 0 comments Download
M trytond/ir/ui/icon.py View 1 chunk +10 lines, -5 lines 0 comments Download
M trytond/ir/ui/menu.py View 2 chunks +11 lines, -7 lines 0 comments Download
M trytond/ir/ui/view.py View 4 chunks +41 lines, -23 lines 0 comments Download
M trytond/ir/view/cron_form.xml View 1 chunk +2 lines, -1 line 0 comments Download
M trytond/ir/view/cron_list.xml View 1 chunk +2 lines, -1 line 0 comments Download
M trytond/ir/view/model_data_form.xml View 1 chunk +2 lines, -1 line 0 comments Download
M trytond/ir/view/model_data_list.xml View 1 chunk +2 lines, -1 line 0 comments Download
M trytond/ir/view/module_form.xml View 1 chunk +12 lines, -6 lines 0 comments Download
M trytond/ir/view/module_list.xml View 1 chunk +8 lines, -4 lines 0 comments Download
M trytond/ir/view/ui_view_form.xml View 1 chunk +1 line, -1 line 0 comments Download
M trytond/model/dictschema.py View 1 chunk +9 lines, -6 lines 0 comments Download
M trytond/model/order.py View 1 chunk +3 lines, -2 lines 0 comments Download
M trytond/res/group.py View 1 chunk +12 lines, -7 lines 0 comments Download
M trytond/res/ir.py View 3 chunks +7 lines, -5 lines 0 comments Download
M trytond/res/user.py View 4 chunks +52 lines, -28 lines 0 comments Download
M trytond/res/view/user_application_form.xml View 1 chunk +4 lines, -2 lines 0 comments Download
M trytond/res/view/user_application_list.xml View 1 chunk +2 lines, -2 lines 0 comments Download

Messages

Total messages: 3
udono
4 weeks, 1 day ago (2017-12-26 11:04:29 UTC) #1
reviewbot
https://codereview.tryton.org/44551003/diff/1/trytond/res/ir.py#newcode125 trytond/res/ir.py:125: F841 local variable 'database' is assigned to but never used https://codereview.tryton.org/44551003/diff/1/trytond/res/user.py#newcode548 trytond/res/user.py:548: E712 ...
4 weeks ago (2017-12-26 11:33:42 UTC) #2
pokoli
1 week, 6 days ago (2018-01-11 09:43:24 UTC) #3
Thanks for your work. 

I haven't review all the code but there are some guideliness comments that
should be applied to all the files specially the Manage on the One2Many

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py
File trytond/ir/action.py (right):

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode36
trytond/ir/action.py:36: help="The model which specifies the result of the
action like "
I do not think it clarifies anything.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode41
trytond/ir/action.py:41: 'Keywords', help="Manage the structural locations where
the action is "
why not: "Add keywords to expose the action on client actions"

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode46
trytond/ir/action.py:46: help="The name of the SVG graphic to represent the
action.")
I don't think whe should talk about SVG

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode47
trytond/ir/action.py:47: active = fields.Boolean('Active', select=True,
help="Uncheck to exclude "
better to include help in a new line so there is no need to break it.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode117
trytond/ir/action.py:117: help="Defines where the action is linked.")
Not sure if we should talk about action or about keyword here

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode404
trytond/ir/action.py:404: help="The model where the report template is
applied.")
The model on which the template is applied.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode412
trytond/ir/action.py:412: depends=['is_custom'], help="The full name and path of
the report "
The report path relative to MODULES_DIR

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode427
trytond/ir/action.py:427: help="Check if the report template is applied
separately "
I don't think we need to change this help text.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode721
trytond/ir/action.py:721: "Action act window"
Should be changed too

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode724
trytond/ir/action.py:724: help="The domain which is applied when opening a
window.")
Why not: "Use to restrict the window records"

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode728
trytond/ir/action.py:728: help="The sort order of records shown in the window.")
Indeed is the default one as the use can customize latter.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode738
trytond/ir/action.py:738: 'act_window', 'Views', help="Manage the views.")
For One2Many we use the following clause: "Add XXXX to the XXXX".

So it will be:

Add Views to the Action Window.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode741
trytond/ir/action.py:741: 'act_window', 'Domains', help="Manage the window
domains.")
Idem abount Manage and Add

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode949
trytond/ir/action.py:949: "Action act window view"
Probably it should also be changed

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode952
trytond/ir/action.py:952: help="The order of the views on switching views.")
From guideliness: Sequence: The position of the MODEL-NAME in a list.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode954
trytond/ir/action.py:954: ondelete='CASCADE', help="The view of the action.")
Does it add any extra information?

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode956
trytond/ir/action.py:956: ondelete='CASCADE', help="The action of the view.")
Does it add any extra information?

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode999
trytond/ir/action.py:999: "Action act window domain"
Should be updated if you name the model Tab domain

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode1003
trytond/ir/action.py:1003: sequence = fields.Integer('Sequence', required=True,
guidelinessa bout sequence

https://codereview.tryton.org/44551003/diff/1/trytond/ir/action.py#newcode1008
trytond/ir/action.py:1008: help="Show the total number of records on the tab.")
on the tab -> matching the domain

https://codereview.tryton.org/44551003/diff/1/trytond/ir/attachment.py
File trytond/ir/attachment.py (right):

https://codereview.tryton.org/44551003/diff/1/trytond/ir/attachment.py#newcode41
trytond/ir/attachment.py:41: help="The type defines the kind of attachment as
upload or link.")
We should not mention the options on a selection list. They should be self
explanatory.

For me there is no need to add any help for type.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/attachment.py#newcode43
trytond/ir/attachment.py:43: help="The textual information about the
attachment.")
I don't think it adds any valuable information

https://codereview.tryton.org/44551003/diff/1/trytond/ir/attachment.py#newcode56
trytond/ir/attachment.py:56: help="Shows the identifier of an attachment file.")
I don't think it adds any valuable information

https://codereview.tryton.org/44551003/diff/1/trytond/ir/attachment.py#newcode60
trytond/ir/attachment.py:60: help="Shows the data size of an attachment file."),
'get_size')
I don't think it adds any valuable information

https://codereview.tryton.org/44551003/diff/1/trytond/ir/cron.py
File trytond/ir/cron.py (right):

https://codereview.tryton.org/44551003/diff/1/trytond/ir/cron.py#newcode44
trytond/ir/cron.py:44: help="The user who will receive alerts in case of
failure.")
alerts -> email notificiation or only notification

https://codereview.tryton.org/44551003/diff/1/trytond/ir/cron.py#newcode46
trytond/ir/cron.py:46: help="Set false to exclude the cron job from future
use.")
Guideliness: Uncheck to exclude the MODEL-NAME from future use.

https://codereview.tryton.org/44551003/diff/1/trytond/ir/export.py
File trytond/ir/export.py (right):

https://codereview.tryton.org/44551003/diff/1/trytond/ir/export.py#newcode15
trytond/ir/export.py:15: help="The main identifier of the preset export.")
I don't think we should use the preset word
Sign in to reply to this message.

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld bc8b922