Ticket #6859 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Wikimaker should ignore paths

Reported by: Owen Arnold Owned by: Owen Arnold
Priority: major Milestone: Release 2.5
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: Tester: Gesner Passos

Description

Jose Borreguero reported a recent issue with wikimaker. The algorithm FFT was not providing a Description section, even though the section existed in the source code. The reason for this is that there is another file called FFT.cpp in MantidPlot, and that file was being identified as the source for the documentation. The best way to handle this duplicate problem is to ignore certain paths. Any python or cpp files under the MantidPlot directory can safely be ignored by wikimaker.

Change History

comment:1 Changed 7 years ago by Owen Arnold

  • Status changed from new to accepted

comment:2 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:3 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:4 Changed 7 years ago by Owen Arnold

  • Status changed from accepted to verify
  • Resolution set to fixed

Tester. You can see the current behaviour by looking at the recent job failures for ​http://download.mantidproject.org/jenkins/view/Static%20Analysis/job/isis_wikimaker/ FFT is listed toward the top, and it is complaining that no description can be found.

Now look at the source code for FFT.cpp in Algorithms. Notice that there is actually a *WIKI* section so it should work.

Now, with the new changes, run wikimaker (locally) with all the these options applied --dry-run --report and for the algorithm specify ALL. Once wikimaker has completed. Look at the generated report (WikiReport.xml), and you should see FFT, but the diff should indicate that it is now picking up the description section correctly.

Branch is bugfix/6859_ignore_paths

comment:5 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:6 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:7 Changed 7 years ago by Gesner Passos

  • Status changed from verify to verifying
  • Tester set to Gesner Passos

comment:8 Changed 7 years ago by Gesner Passos

This solved the issue for FFT, Fit, FlatBackground and Integration

But introduces problems for: CreateMDWorkspace, StepScan

I've applied the wiki_maker for all the names of the files I've found duplicated inside the Code. When a real algorithm was found, it has applied the wiki_maker. I've found only these 6 elements. Is it possible to have an algorithm that is not the root of the file? (I mean FFT.cpp --> FFT algorithm).

comment:9 Changed 7 years ago by Gesner Passos

  • Status changed from verifying to reopened
  • Resolution fixed deleted

comment:10 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:11 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:12 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:13 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:14 Changed 7 years ago by Owen Arnold

  • Status changed from reopened to accepted

comment:15 Changed 7 years ago by Owen Arnold

  • Status changed from accepted to verify
  • Resolution set to fixed

comment:16 Changed 7 years ago by Gesner Passos

  • Status changed from verify to verifying

comment:17 Changed 7 years ago by Gesner Passos

Issues presented on ​comment8 solved!

comment:18 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:19 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:20 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:21 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:22 Changed 7 years ago by Gesner Passos

  • Status changed from verifying to closed

comment:23 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:24 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:25 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:26 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:27 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:28 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:29 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:30 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:31 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:32 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:33 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:34 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:35 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:36 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:37 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:38 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:39 Changed 7 years ago by Owen Arnold

refs #6859 ignore MantidPlot dir.

Changeset: 4f6e476cfe7f40412fea938144318a1d6e04624f

comment:40 Changed 7 years ago by Owen Arnold

refs #6859. Remove debug statements.

Changeset: d49ecaa22577f4a9d214df2222cd7a30d47dd2bf

comment:41 Changed 7 years ago by Owen Arnold

refs #6859. Blacklist several directories.

Changeset: c3500a9841f48840f982a03ff630b3125e921d53

comment:42 Changed 7 years ago by Owen Arnold

refs #6859. Fix blacklist.

Changeset: b30dc16f1be59e6f7ba5b1489fff5208bc126a7b

comment:43 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7705

Note: See TracTickets for help on using tickets.