Ticket #10891 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

ExportSampleLogsToCSVFile confusing properties

Reported by: Owen Arnold Owned by: Wenduo Zhou
Priority: critical Milestone: Release 3.4
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester: Federico M Pouzols

Description

ExportSampleLogsToCSVFile is a useful feature. However, the interface suggests that you can specify a TimeZone. This property has no documenation, and it really deserves a full explanation of what setting the timezone will actually do.

I'm setting this to critical, because we have external users (not instrument scientists) scratching their heads about this.

  • Add a property description
  • Describe in the detailed documentation what shift is going to be applied. Remembering that the users won't necessarily know anything about the underlying time format.

Change History

comment:1 Changed 6 years ago by Owen Arnold

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Wenduo Zhou

  • Status changed from assigned to inprogress

comment:3 Changed 6 years ago by Wenduo Zhou

Refs #10891. Made some changes.

Changeset: df246fa61b84310cbe00579da0508cab0a791655

comment:4 Changed 6 years ago by Wenduo Zhou

Refs #10891. Finished improving the documentation.

On branch feature/10891_ExportSampleLogs_Doc

  • modified: ExportSampleLogsToCSVFile-v1.rst

Changeset: 73125284ebd4901bb8840f3465eec820cb10683d

comment:5 Changed 6 years ago by Wenduo Zhou

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

This is being verified as ​pull request #333.

comment:6 Changed 6 years ago by Federico M Pouzols

  • Status changed from verify to verifying
  • Tester set to Federico M Pouzols

comment:7 Changed 6 years ago by Federico M Pouzols

The documentation is more specific now, explaining the what and how. I've never used this algorithm but I'd know how to use it from this extended description. I only have a comment (see the comment inline). Please let me know what you think, and I'll merge the changes in.

comment:8 Changed 6 years ago by Federico M Pouzols

  • Status changed from verifying to closed

Merge pull request #333 from mantidproject/feature/10891_ExportSampleLogs_Doc

Impove documentation for ExportSampleLogsToCSVFile

Full changeset: ​fecb737d9e3e0dff54b77b04dce0f5e57482d3ac

comment:9 Changed 5 years ago by Nick Draper

Somehow these slipped through without a resolution. Set to Fixed.

comment:10 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​11730

Note: See TracTickets for help on using tickets.