Ticket #6858 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add wiki documentation to IFunctions

Reported by: Peter Peterson Owned by: Peter Peterson
Priority: major Milestone: Release 2.5
Component: Mantid Keywords:
Cc: nick.draper@… Blocked By:
Blocking: Tester: Michael Reuter

Description (last modified by Peter Peterson) (diff)

Much like the algorithms have a WIKI section at the top of the source files, add a WIKI section to the top of the fit functions. Getting this information will be added as an additional function in wiki_tools and outputting it will be added to the offline help.

Change History

comment:1 Changed 7 years ago by Peter Peterson

  • Status changed from new to accepted
  • Description modified (diff)

Mathml is a dead end as qt-assistant doesn't render any of the intersting equations.

comment:2 Changed 7 years ago by Peter Peterson

Re #6858. Quieting doxygen errors.

Changeset: 742a3a99b83a3dd1b86a5579ce0de17733e2e55e

comment:3 Changed 7 years ago by Peter Peterson

Re #6858. Making indexes explicitely depend on some sub-projects.

Changeset: 2a960c156e725e785151acc911c183e18cc4621d

comment:4 Changed 7 years ago by Peter Peterson

Re #6858. Added infrastructure to extract wiki from IFunctions.

Changeset: 18a8b3d86ac5a30ec0e156747ed2093d3914052c

comment:5 Changed 7 years ago by Peter Peterson

Re #6858. Added docs to IFunctions.

What little wiki docs there were have been (verbatim) copied over.

Changeset: f7d3a550d4182463fdc7dfb09257578827f430c0

comment:6 Changed 7 years ago by Peter Peterson

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

This is on ​feature/6858_fitfunc_wiki.

To test it out bring up the help and look that (some) of the fit functions have help. Most of the muon ones do. There is still active problems with parsing the wiki for links, equations, and images. That is a ticket yet to be written.

comment:7 Changed 7 years ago by Karl Palmen

  • Status changed from verify to verifying
  • Tester set to Karl Palmen

comment:8 Changed 7 years ago by Karl Palmen

  • Status changed from verifying to verify
  • Tester Karl Palmen deleted

I cannot find the fit functions in help, just algorithms. If the help refered to can only be accessed by running the fit finctions, I cannot test, because the fit functions are not enabled for me #6472.

I have not found any muon fitting function for which wikimaker has been used.

comment:9 Changed 7 years ago by Michael Reuter

  • Status changed from verify to verifying
  • Tester set to Michael Reuter

comment:10 Changed 7 years ago by Peter Peterson

Re #6858. Quieting doxygen errors.

Changeset: 742a3a99b83a3dd1b86a5579ce0de17733e2e55e

comment:11 Changed 7 years ago by Peter Peterson

Re #6858. Making indexes explicitely depend on some sub-projects.

Changeset: 2a960c156e725e785151acc911c183e18cc4621d

comment:12 Changed 7 years ago by Peter Peterson

Re #6858. Added infrastructure to extract wiki from IFunctions.

Changeset: 18a8b3d86ac5a30ec0e156747ed2093d3914052c

comment:13 Changed 7 years ago by Peter Peterson

Re #6858. Added docs to IFunctions.

What little wiki docs there were have been (verbatim) copied over.

Changeset: f7d3a550d4182463fdc7dfb09257578827f430c0

comment:14 Changed 7 years ago by Michael Reuter

  • Status changed from verifying to closed

This looks to be working just fine. Nice to have the documentation in house.

comment:15 Changed 7 years ago by Peter Peterson

Re #6858. Quieting doxygen errors.

Changeset: 742a3a99b83a3dd1b86a5579ce0de17733e2e55e

comment:16 Changed 7 years ago by Peter Peterson

Re #6858. Making indexes explicitely depend on some sub-projects.

Changeset: 2a960c156e725e785151acc911c183e18cc4621d

comment:17 Changed 7 years ago by Peter Peterson

Re #6858. Added infrastructure to extract wiki from IFunctions.

Changeset: 18a8b3d86ac5a30ec0e156747ed2093d3914052c

comment:18 Changed 7 years ago by Peter Peterson

Re #6858. Added docs to IFunctions.

What little wiki docs there were have been (verbatim) copied over.

Changeset: f7d3a550d4182463fdc7dfb09257578827f430c0

comment:19 Changed 7 years ago by Peter Peterson

Re #6858. Quieting doxygen errors.

Changeset: 742a3a99b83a3dd1b86a5579ce0de17733e2e55e

comment:20 Changed 7 years ago by Peter Peterson

Re #6858. Making indexes explicitely depend on some sub-projects.

Changeset: 2a960c156e725e785151acc911c183e18cc4621d

comment:21 Changed 7 years ago by Peter Peterson

Re #6858. Added infrastructure to extract wiki from IFunctions.

Changeset: 18a8b3d86ac5a30ec0e156747ed2093d3914052c

comment:22 Changed 7 years ago by Peter Peterson

Re #6858. Added docs to IFunctions.

What little wiki docs there were have been (verbatim) copied over.

Changeset: f7d3a550d4182463fdc7dfb09257578827f430c0

comment:23 Changed 7 years ago by Peter Peterson

Re #6858. Quieting doxygen errors.

Changeset: 742a3a99b83a3dd1b86a5579ce0de17733e2e55e

comment:24 Changed 7 years ago by Peter Peterson

Re #6858. Making indexes explicitely depend on some sub-projects.

Changeset: 2a960c156e725e785151acc911c183e18cc4621d

comment:25 Changed 7 years ago by Peter Peterson

Re #6858. Added infrastructure to extract wiki from IFunctions.

Changeset: 18a8b3d86ac5a30ec0e156747ed2093d3914052c

comment:26 Changed 7 years ago by Peter Peterson

Re #6858. Added docs to IFunctions.

What little wiki docs there were have been (verbatim) copied over.

Changeset: f7d3a550d4182463fdc7dfb09257578827f430c0

comment:27 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​7704

Note: See TracTickets for help on using tickets.