Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve First Time setup #11508

Closed
NickDraper opened this issue Dec 2, 2014 · 2 comments
Closed

Improve First Time setup #11508

NickDraper opened this issue Dec 2, 2014 · 2 comments
Assignees
@NickDraper
Milestone
Release 3.3

Comments

@NickDraper
Copy link
Contributor

Make it more visually appealing and add links to the training courses, sample data and release notes.
@NickDraper
Copy link
Contributor Author

This issue was originally trac ticket 10666

@NickDraper
Copy link
Contributor Author

http://trac.mantidproject.org/mantid/raw-attachment/ticket/10666/NewSplashScreen.png
NewSplashScreen.png
(uploaded by @martyngigg on 2014-12-02T22:38:10)

@NickDraper NickDraper added the GUI label Jun 3, 2015
@NickDraper NickDraper self-assigned this Jun 3, 2015
@NickDraper NickDraper added this to the Release 3.3 milestone Jun 3, 2015
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Initial commit and test project
e430e52
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Initial rumbling
009c897 
minor changes to identify change in instrument size if description is added to a parameter
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Adding description to some parameters and param factory
4d47207
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 finished adding description to all ParameterMap methods
24e7116
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 attempts to fix unit test (unsuccessful yet)
7c24a6d
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 fixed old unit tests
8532933
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Unit test for help string
11e742b
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Started to modify InstrumenDefinitionParser
3d487c1 
to understand description
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 redefined tooltip as all before .
837dcc1 
and added processing to IDF processing algorithm.
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Looks like can get a parameter description
b1d9aef 
and unit test for accessor.
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Help string interface on component
671ca69 
(not yet tested)
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Exported accessors and mutators to python
83602c7 
and it works.
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Doxygen and sample Parameter change
68e13ea
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 One more doxygen error
09b749f
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 fixing xml schema and system tests
4238d83
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 fixing IDF schema
3a68ae9
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Attempt to identify the reason for failure on MAC
91b4d6e
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Further chasing MAC compilation problems
ebaee20
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 fixing cppcheck (and missing description for couple of par)
467e12a
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Fake changes to kick disappeared MAC test
9f160e0
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Trying to get proper build on OSX
a36bd2a
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Nailing down OSX failure.
4574276 
Completely remove offending includes from test file
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Chasing problem with OSX
6226419 
and a bit more unit testing on the way.
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Addressing the reviewer comments
4f64016 
1) Tooltip name changed to short description

2) Why simply not use m_description = source?
because for strings m_description = source compiles into something like
if !(&rhs == this)
   lhs.assign(rhs)

3) The names of these methods don't properly reflect what they do. For example, Component::getDescription would imply that the description is about the component, not the parameter...

The name means exactly this. Component::getDescription provides the description for a parametrized component. By current agreement (at least enforced by unit tests), a parametrized component would have a parameter with the same name. If it does not, empty description will be returned. If one sets description for a component, a parameter with component name will be created if not already present. I do not need this feature but decided that it would be nice to have as implementation is really trivial, behaves similarly to all other stuff in components and may be useful to somebody.

4) From my perspective, would these not be a better set of methods:  getParameterDescription, getShortParameterDescription,setParameterDescription...

Done. Except I've used getParamDescription etc instead of getParameterDescription -- it is as descriptive as suggested but saves a bit of typing.
setParamDescription is not implemented. It is not entirely trivial and I do not need it so let's leave it to somebody who(if) actually needs it.

5) I think the description would be more sensible as simply the value of the description element rather than an attribute, i.e....

I make it the same as 12 other (parameters? attributes? components?) parts of the Instrument tree are. Though doing it the suggested way would be better, all other parts are implemented this way. Introducing new entities would be a bit too much for such a small change to the instrument tree. But it its really desired we may create a separate ticket to do such change with this and number of other instrument components. I only suspect that the gain is not worth the efforts, though would be nice.

I think the changes made to the ticket address all remarks.
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Pylint warnings
80f37dc
AndreiSavici added a commit that referenced this issue Jun 3, 2015
@AndreiSavici
Simple pylint fixes. Refs #11508
ec2167e
AndreiSavici added a commit that referenced this issue Jun 3, 2015
@AndreiSavici
Trying to fix systemtests. Refs #11508
1eb5488
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 resolving conflicts with master
74d5147 
Merge branch 'master' into 11508_ParamWithHelpString

Conflicts:
	Code/Mantid/Framework/Geometry/src/Instrument/Component.cpp
	Code/Mantid/Framework/PythonInterface/mantid/geometry/src/Exports/Component.cpp
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 Fixed merge error.
85b034c
abuts added a commit that referenced this issue Jun 3, 2015
@abuts
Re #11508 merging master to fix doctest as changes are due to the bug
4f2b374 
fixed there.

Merge branch 'master' into 11508_ParamWithHelpString

Conflicts:
	Code/Mantid/Framework/PythonInterface/mantid/geometry/src/Exports/Component.cpp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NickDraper NickDraper

Labels
None yet
Projects
None yet
Milestone
Release 3.3
Development

No branches or pull requests
1 participant
@NickDraper