Ticket #11500 (closed)

Opened 6 years ago

Last modified 5 years ago

Write help strings into reduce_vars.py file

Reported by: Alex Buts Owned by: Alex Buts
Priority: major Milestone: Release 3.4
Component: Direct Inelastic Keywords:
Cc: lottie.greenwood@…, marcus.noble@… Blocked By:
Blocking: Tester: Federico Montesino Pouzols

Description

Autoreduction can currently display help about the properties if help strings are written into reduce_vars.py

The purpose of this ticket is to write doc strings from properties to appropriate dictionary of reduce_vars.py

Change History

comment:1 Changed 6 years ago by Alex Buts

  • Status changed from new to inprogress

Re #11500 initial commits.

Minor changes to ReductionWrapper in case user retrieves workspace with the name equal to internal workspace.

Changeset: aea204404dd02b0fb7cca21fb87b6a97a3a521b5

comment:2 Changed 6 years ago by Alex Buts

Re #11500 generate help_vars from existing docstrings

formally works but is the format acceptable to web services?

Changeset: b3cd3cde25a523ca7a9df3bb4648d9abcfe479c2

comment:3 Changed 6 years ago by Alex Buts

Re #11500 This should generate help compatible with web application

Changeset: 46fff86082aed09d50d0e79338d01c64a1d7f4b9

comment:4 Changed 6 years ago by Alex Buts

Re #11500 Changes to properties descriptions

to provide better help to these properties.

Changeset: 61ab8760d32effaf1a97ced436825d7c3a6681f0

comment:5 Changed 6 years ago by Alex Buts

Re #11500 Minor formatting for docstrings.

typos, commas, wording etc...

Changeset: 569de4aa132a78e0e1bf0b12dcaa18227f21fbc8

comment:6 Changed 6 years ago by Alex Buts

  • Cc lottie.greenwood@…, marcus.noble@… added

This is fixed as PR https://github.com/mantidproject/mantid/pull/555

The purpose of the ticket is to write existing reduction docstrings from reduction property into reduce_vars.py file in the format, which autoreduction web app would understand.

this is done and autoreduction indeed understands what is written. (I've tested it with Lottie) The changes are pretty simple and work so code review is probably sufficient to test it.

More complex task exists to retrieve all existing help for properties &automatic properties from e.g. Instrument_Parameters.xml to autoreduction and reduction itself. This is the purpose of other tickets.

comment:7 Changed 5 years ago by Alex Buts

Re #11500 Modified diagnostics to run correct bleed test for nxs files

good frame rate log apparently have different name for nxs files.

This change have no relation to help system but trivial and urgently requested by instrument scientist.

Changeset: 65e79c382534ca4af6d3e48253424516ddc978f6

comment:8 Changed 5 years ago by Federico Montesino Pouzols

  • Status changed from inprogress to verifying
  • Tester set to Federico Montesino Pouzols

comment:9 Changed 5 years ago by Federico Montesino Pouzols

This extends miscellaneous reduction documentation strings and makes the documentation of properties available to autoreduce. The docs read well and everything looks fine. As a bonus, an error check for availability of logs has been added in direct / diagnostics.py.

comment:10 Changed 5 years ago by Federico Montesino Pouzols

  • Status changed from verifying to closed

Merge pull request #555 from mantidproject/11500_helpForAutoreduction

Help for autoreduction

Full changeset: 7eb8775152b32e51cd8e9d86ab7939284baf2eb7

comment:11 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 12338

Note: See TracTickets for help on using tickets.