Ticket #9006 (closed: fixed)
Optional Short Description for each Algorithm Property
Reported by: | Karl Palmen | Owned by: | Russell Taylor |
---|---|---|---|
Priority: | major | Milestone: | Release 3.2 |
Component: | Framework | Keywords: | maintenance CORE |
Cc: | Blocked By: | ||
Blocking: | #8917 | Tester: | Samuel Jackson |
Description
If an algorithm property has a long property description, it would be desirable to also have a short description, which shows up when the mouse is moved over it in the GUI.
The default for the short description would be the description, which would be acceptable for properties whose description is long.
This ticket is required as part of #8917
Change History
comment:2 Changed 7 years ago by Karl Palmen
CaltoDspacemap would be good example to apply this to, if it were not removed.
comment:3 Changed 7 years ago by Nick Draper
- Owner set to Russell Taylor
Russell, Could you take this one?
comment:4 Changed 7 years ago by Nick Draper
- Status changed from new to assigned
Bulk move of tickets out of triage (new) to assigned at the introduction of the triage state
comment:7 Changed 6 years ago by Russell Taylor
- Status changed from assigned to inprogress
Re #9006. Add a brief documentation field to Property.
This is by default set when the full documentation field is set and will consist of the text up to the first period, or the entire text if no period. An setter method is also provided to override this.
Changeset: a79082cbe935edb14d9b0201b97debb2aadfcd2d
comment:8 Changed 6 years ago by Russell Taylor
Re #9006. Use short property description in GUI tooltips.
Changeset: 8b3499485b7469655419c8ee965ec5bb2dc6bfc9
comment:9 Changed 6 years ago by Russell Taylor
Re #9006. Put back the full stop in the case where text is added.
Changeset: ee874dbbfe900ba9d546407f10dfa54f27737f34
comment:10 Changed 6 years ago by Russell Taylor
Re #9006. Update a few property descriptions.
Changeset: e6b9c152d5417e6e4e36ee5ad5cab97a87f9e0a3
comment:11 Changed 6 years ago by Russell Taylor
Re #9006. Update test following property description changes.
Changeset: 5698b5d475115164c3024da91b5945c10cfa3e0a
comment:12 Changed 6 years ago by Russell Taylor
- Status changed from inprogress to verify
- Resolution set to fixed
Test by checking that tooltips in algorithm dialogs (generic & custom) show the short version (first or only sentence), and that python docs show the long version. Checking that the description of every single algorithm property has transformed to something sensible is outside the scope of this ticket, though if you spot anything that needs fixing do fix or note it.
comment:13 Changed 6 years ago by Samuel Jackson
- Status changed from verify to verifying
- Tester set to Samuel Jackson
comment:14 Changed 6 years ago by Samuel Jackson
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9006_short_algproperty_description'
Full changeset: 838a0d94a8958eac7ef55a6047e4e4c999d1bd5a
comment:15 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 9849