Ticket #7484 (closed: fixed)
Improve language in LoadGSS and SaveGSS
Reported by: | Karl Palmen | Owned by: | Karl Palmen |
---|---|---|---|
Priority: | major | Milestone: | Release 2.6 |
Component: | Framework | Keywords: | maintenance |
Cc: | Blocked By: | ||
Blocking: | Tester: | Keith Brown |
Description
While test ticket #7426 I found the English is some of the statements needs improving. In particular LoadGSS.cpp line 417 has a confusing error message
"It seems not possible to have mismatch spectrum numbers and nHist."
I think it means that the number of spectrum numbers and number of histograms do not match (and must match).
Also I've seen minor grammatical error in the decription of the new UseBankIDasSpectrumNumber property.
Change History
comment:3 Changed 7 years ago by Karl Palmen
Improve error message re #7484
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: f1717a88c49261a198df83cc6377ea3d387e7637
comment:4 Changed 7 years ago by Karl Palmen
Other language improvements re #7484
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 2367f3f70f65768cb97528692e645dbb66cb95e8
comment:5 Changed 7 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
To test, review the code and verify that the language has been improved and is accurate. You could also try running LoadGSS on a modified copy of gss1.txt of AutoTestData to get exceptions thrown.
comment:6 Changed 7 years ago by Keith Brown
- Status changed from verify to verifying
- Tester set to Keith Brown
comment:7 Changed 7 years ago by Keith Brown
- Status changed from verifying to reopened
- Resolution fixed deleted
Some of these may be a bit pedantic, but here are a few changes I'd make seeing how this ticket is about making these algorithms more grammatically correct or worded better.
SaveGSS.cpp
line 67 (seemed a bit clunky before, now follows a plain English if-construct style)
declareProperty("Append", true, "If Filename already exists, append if true, otherwise overwrite");
line 128 (made wording almost identical to g_log.error() on previous line)
throw new std::invalid_argument("Spectra number cannot be larger than 99 for a GSAS file");
line 241 (original wording had bad grammar)
throw std::runtime_error("Cannot write to the unknown " + outputFormat + "output format");
LoadGSS
line 419 (personally I'd bracket the numeric values)
mess << "Number of spectra (" << detectorIDs.size() << ") is not equal to number of histograms (" << nHist << ").";
comment:9 Changed 7 years ago by Karl Palmen
Make changes similar to those suggest by Keith Brown re #7484
Signed-off-by: Karl Palmen <karl.palmen@…>
Changeset: 9bcbda86954b89c83a960e0ebd204d6a97c2e89a
comment:10 Changed 7 years ago by Karl Palmen
- Status changed from inprogress to verify
- Resolution set to fixed
comment:12 Changed 7 years ago by Keith Brown
- Status changed from verifying to closed
Messages have been improved
comment:13 Changed 7 years ago by Keith Brown
Still needs merged to master, unable at present due to another ticket building
comment:14 Changed 7 years ago by Keith Brown
merged to master now
comment:15 Changed 7 years ago by Keith Brown
Merge remote-tracking branch 'origin/feature/7484_better_language'
comment:16 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 8329