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

Documentation/Consistency for input parameters e.g. workspace index vs spectrum number #12069

Closed
martyngigg opened this issue Mar 4, 2015 · 3 comments · Fixed by #13363
Closed

Documentation/Consistency for input parameters e.g. workspace index vs spectrum number #12069

martyngigg opened this issue Mar 4, 2015 · 3 comments · Fixed by #13363
Assignees
@NickDraper
Labels
Framework Issues and pull requests related to components in the Framework High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Milestone
Release 3.5

Comments

@martyngigg
Copy link
Member

This issue was originally TRAC 11230

Algorithm inputs and documentation can sometimes use the terms workspace index and spectrum number interchangeable when they shouldn't.

Contact Ron Smith at ISIS to see if he has any concrete examples.

Keywords: SSC 2015 isis frameOther
@martyngigg
Copy link
Member Author

@NickDraper (2015-03-10T15:49:01):
Batch modify all SSC tickets to critical priority (this will also show up as an update for all those already as critical)

@martyngigg (2015-03-20T15:45:56):
Esitmate for information gathering: 2 days

@NickDraper (2015-05-12T14:03:07):
Moved to R3.5 at the end of R3.4

@martyngigg martyngigg added High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Framework Issues and pull requests related to components in the Framework SSC labels Jun 3, 2015
@martyngigg martyngigg added this to the Release 3.5 milestone Jun 3, 2015
@NickDraper
Copy link
Contributor

Searched Documentation with regexes

workspace\s*index.*spectrum\s*number
and
spectrum\s*number.*workspace\s*index

Found the following files that include both terms

  • CalculateGammaBackground-v1.html
  • EventWorkspace.html
  • GetDetOffsetsMultiPeaks-v1.html
  • GroupDetectors-v2.html
  • IEventWorkspace.html
  • Integration-v1.html
  • MatrixWorkspace.html
  • VesuvioResolution-v1.html

Those ticked with no further comment have been checked and are fine

@NickDraper
Copy link
Contributor

Issue corrected in

  • GetDetOffsetsMultiPeaks-v1.html
  • GroupDetectors-v2.html
  • VesuvioResolution-v1.html

NickDraper added a commit that referenced this issue Aug 12, 2015
@NickDraper
correct workspace index vs spectra number ambiguitities
16e07a5 
re #12069
@NickDraper NickDraper mentioned this issue Aug 12, 2015
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NickDraper NickDraper

Labels
Framework Issues and pull requests related to components in the Framework High Priority An issue or pull request that if not addressed is severe enough to postponse a release.
Projects
None yet
Milestone
Release 3.5
Development

Successfully merging a pull request may close this issue.

correct workspace index vs spectra number ambiguitities mantidproject/mantid
2 participants
@martyngigg @NickDraper