Documentation: Window layout

palaeoware / trevosim

TREvoSim - The [Tr]ee [Evo]lutionary [Sim]ulator program

GNU General Public License v3.0

4 stars 3 forks source link

Documentation: Window layout #16

Open ms609 opened 2 months ago

ms609 commented 2 months ago

Re: https://github.com/openjournals/joss-reviews/issues/6722

The Window Layout page gives a clear explanation of the interface and the structure is intuitive and easy to follow.

[x] The images are useful, but are rendered at a maximum 696px width (smaller on a narrow browser window), but have an intrinsic width of 1500px. Key details are thus too small to clearly distinguish. I would suggest preparing the screen grabs at the size they will be rendered, i.e. resizing the TREvoSim window to the minimum dimensions in which the key features can be seen, so that these are maximally legible to readers of the documentation.
[x] A textual description of the appearance of the toolbar (e.g. with ""with buttons greyed out" in place of "as follows") would improve accessibility
[ ] No messages appeared in the Status Bar during or after a run with the default parameters (i.e. open software and press "run").

RussellGarwood commented 4 weeks ago

With above commit I've improved the wording of this page, thanks for the pointer.

I've also marked as completed the "No messages" point, because I believe this resulted from the way I had previously coded the software to deal with slow GUI updates. This was fixed in commits about a week ago, and certainly on Linux the status bar updates every iteration to give the iteration number. It would be good to know if this isn't the case on windows (i.e. that this issue wasn't related to my old approach to writing the GUI).

RussellGarwood commented 4 weeks ago

I think this is all done!

ms609 commented 2 weeks ago

I still don't see any messages in the status bar on Windows (commit: cd138dbcbff2f31beb59d91b88f14fa86ccc6c03)

RussellGarwood commented 2 weeks ago

Just to be sure, does this include the message "Iteration: XX" when a simulation runs?

If so, I think the status bar itself doesn't seem to work on windows, and I should have a dig around!

ms609 commented 2 weeks ago

No "Iteration" message is visible; the bar remains blank.

RussellGarwood commented 2 weeks ago

Thanks for confirming!

RussellGarwood commented 2 weeks ago

Hmm, on a windows build here by @alanspencer we definitely have status messages appearing: is it possible this has not updated all elements since you pulled the latest version? One way to check would be to clear or rename your build directory and then rebuild.

ms609 commented 2 weeks ago

I've just pulled the latest version, deleted the build directory, and re-built; still no status messages.

RussellGarwood commented 4 days ago

Apologies, we have not been able to reproduce the lack of status message on any windows build on this end - as such we're at a bit of a loss as to what to do about it!