Ticket #9592 (closed: fixed)
Move/Remove last few occurrences of "WIKI" in the codebase
Reported by: | Russell Taylor | Owned by: | Nick Draper |
---|---|---|---|
Priority: | minor | Milestone: | Release 3.2 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | ||
Blocking: | Tester: | Martyn Gigg |
Description (last modified by Jay Rainey) (diff)
It's found in:
- ./SINQ/src/SliceMDHisto.cpp:/**WIKI*
- ./SINQ/src/SliceMDHisto.cpp:*WIKI*/
- ./Crystal/inc/MantidCrystal/CentroidPeaks.h:/*WIKI*
- ./Crystal/inc/MantidCrystal/CentroidPeaks.h:*WIKI*/
- ./UserAlgorithms/PropertyAlgorithm.cpp:/*WIKI*
- ./UserAlgorithms/PropertyAlgorithm.cpp:*WIKI*/
- ./UserAlgorithms/ModifyData.cpp:/*WIKI*
- ./UserAlgorithms/ModifyData.cpp:*WIKI*/
- ./UserAlgorithms/WorkspaceAlgorithm.cpp:/*WIKI*
- ./UserAlgorithms/WorkspaceAlgorithm.cpp:*WIKI*/
- ./UserAlgorithms/HelloWorldAlgorithm.cpp:/*WIKI*
- ./UserAlgorithms/HelloWorldAlgorithm.cpp:*WIKI*/
Change History
comment:4 Changed 6 years ago by Jay Rainey
- Status changed from assigned to inprogress
Remove wiki from user algorithms. Refs #9592.
Changeset: ee71d7a658c636b2c4b01f61e11a85381f0d4638
comment:5 Changed 6 years ago by Jay Rainey
Remove wiki from remaining algorithms. Refs #9592.
- Interestingly, CentroidPeaks has an .rst file, which also has the wiki!
- SliceMDHisto on the other hand, did not have an .rst file.
Changeset: 04199e719ca90d90dac7fbb7a006fa6a14a34572
comment:6 Changed 6 years ago by Jay Rainey
- Blocking 9589 added
(In #9589) Added SliceMDHisto to the usage list. Seemed like the right move since you were also working on other SINQ algorithms.
comment:7 Changed 6 years ago by Jay Rainey
- Status changed from inprogress to verify
- Resolution set to fixed
Test by code review.
I was unable to write the usage for either algorithm, so put blockers to the relevant tickets where I assigned them to another developer who was writing usage example for similar algorithms.
comment:8 Changed 6 years ago by Martyn Gigg
Remove incorrectly named algorithm rst
It has actually been dealt with elsewhere anyway. Refs #9592
Changeset: 6afc8513abeca06fdaf1484cc9378e0c66799dca
comment:9 Changed 6 years ago by Michael Wedel
- Blocking 9589 removed
(In #9589) Thanks for the notification. Okay, then I will put it into #9622 along with the three other algorithms that I need more info on and remove the block from this ticket.
If other SINQ-related algorithms appear, without the word "POLDI" in it, please put them into that ticket, as I will likely need more information on that as well before I can document anything. Thanks.
I updated the list in the ticket to reflect the changes.
comment:10 Changed 6 years ago by Owen Arnold
- Status changed from verify to verifying
- Tester set to Owen Arnold
comment:11 Changed 6 years ago by Owen Arnold
A grep of the codebase yielded the following:
./Code/Mantid/Framework/Algorithms/src/RemoveWorkspaceHistory.cpp:/*WIKI* ./Code/Mantid/Framework/Algorithms/src/RemoveWorkspaceHistory.cpp:*WIKI*/ ./Code/Mantid/Framework/Algorithms/src/Stitch1D.cpp:/*WIKI* ./Code/Mantid/Framework/Algorithms/src/Stitch1D.cpp: *WIKI*/ ./Code/Mantid/Framework/DataHandling/src/CreateChunkingFromInstrument.cpp:/*WIKI* ./Code/Mantid/Framework/DataHandling/src/CreateChunkingFromInstrument.cpp:*WIKI*/ ./Code/Mantid/Framework/DataHandling/src/ExtractMonitorWorkspace.cpp:/*WIKI* ./Code/Mantid/Framework/DataHandling/src/ExtractMonitorWorkspace.cpp:*WIKI*/ ./Code/Mantid/MantidQt/API/src/HelpWindow.cpp:const string WIKI_BASE_URL("http://mantidproject.org/"); ./Code/Mantid/MantidQt/API/src/HelpWindow.cpp:const string WIKI_DEFAULT_URL(WIKI_BASE_URL + "MantidPlot"); ./Code/Mantid/MantidQt/API/src/HelpWindow.cpp: openWebpage(WIKI_DEFAULT_URL); ./Code/Mantid/MantidQt/API/src/HelpWindow.cpp: openWebpage(WIKI_DEFAULT_URL); ./Code/Mantid/MantidQt/API/src/HelpWindow.cpp: openWebpage(WIKI_BASE_URL + page); ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: const QString ISIS_SANS_WIKI = "http://www.mantidproject.org/ISIS_SANS:"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::RUN_NUMBERS] = ISIS_SANS_WIKI + "_Run_Numbers"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::REDUCTION_SETTINGS] = ISIS_SANS_WIKI + "_Reduction_Settings"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::GEOMETRY] = ISIS_SANS_WIKI + "_Geometry"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::MASKING] = ISIS_SANS_WIKI + "_Masking"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::LOGGING] = ISIS_SANS_WIKI + "_Logging"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::ADD_RUNS] = ISIS_SANS_WIKI + "_Add_Runs"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::DIAGNOSTICS] = ISIS_SANS_WIKI + "_Diagnostics"; ./Code/Mantid/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp: m_helpPageUrls[Tab::ONE_D_ANALYSIS] = ISIS_SANS_WIKI + "_1D_Analysis"; ./Code/Mantid/Vates/VatesAPI/src/LoadVTK.cpp:/*WIKI* ./Code/Mantid/Vates/VatesAPI/src/LoadVTK.cpp:*WIKI*/ ./Code/Mantid/Vates/VatesAPI/src/LoadVTK.cpp:/*WIKI_USAGE* ./Code/Mantid/Vates/VatesAPI/src/LoadVTK.cpp:*WIKI_USAGE*/
comment:12 Changed 6 years ago by Owen Arnold
- Status changed from verifying to reopened
- Resolution fixed deleted
comment:14 Changed 6 years ago by Nick Draper
Some of these are still valid as we still do have a wiki, but not for algorithms. or fit functions. So out of the GREP I'll fix the following files:
- RemoveWorkspaceHistory
- Stitch1D
LoadVTK- CreateChunkingFromInstrument
- ExtractMonitorWorkspace
comment:15 Changed 6 years ago by Nick Draper
LoadVTK moved to ticket #9654 as it is only available if Vates is built
comment:16 Changed 6 years ago by Nick Draper
Stitch1D documentation has been completed in another ticket, so the rst file is not added here.
comment:17 Changed 6 years ago by Nick Draper
- Status changed from reopened to inprogress
re #9592 remaining wiki usages from algorithms that came in late
Changeset: f7c4505d609a9e3bbaea191ec5d10667b2a93b26
comment:18 Changed 6 years ago by Nick Draper
- Status changed from inprogress to verify
- Resolution set to fixed
to test:
- check the cpp files and rst files for
- RemoveWorkspaceHistory
- Stitch1D
- CreateChunkingFromInstrument
- ExtractMonitorWorkspace
- check that the doctest passes
comment:19 Changed 6 years ago by Martyn Gigg
- Status changed from verify to verifying
- Tester changed from Owen Arnold to Martyn Gigg
comment:20 Changed 6 years ago by Martyn Gigg
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/9592_remove_final_wiki'
Full changeset: c87ea1b6197dcf8deb84ecf39e54769d2a14b1d4
comment:21 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10435