Required docs for next release

[smk78]

Creating this issue as an aide memoir.

Since 5.0.6 was released there is functionality in SasView which has either been changed/improved, or new functionality which has been added, and which is not captured in the help docs. This must be present before a new version can be released. For this reason this issue is labelled as a blocker.

Please record known instances below:_

Already Merged:

• Corfunc Perspective - the perspective has been overhauled and the docs need to be updated to match the current appearance and functionality.

• OpenGL Subsystem - in Developer Documentation; currently says "TODO - data currently in PR".

• Orientation Viewer - no Help button and no docs

• Sasdata - @krzywon says none of the doc strings in Sasdata are currently scraped to the Developer docs.

  • NB: some of @ehewins doc strings in sasdata/data_util/new_manipulations.py and test/sasdataloader/utest_averaging_analytical.py use unicode math and greek symbols for readability. Need to check what Sphinx does with them when Sasdata is scraped.

• Slicers - have been overhauled and the docs need to be updated to match the current appearance and functionality.

• Tutorials:

  • @wpotrzebowski says some Workshop attendees have mentioned that the Data Explorer screenshots in the 'Basic 1D Fitting' tutorial no longer represent current behaviour because of changes to sasdata that pull the data name from the .xml/.h5 files. (It was written for v5.0.0).

Pending Merge:

• Particle Editor

• MuMag

[lucas-wilkins]

You're probably right about corfunc.

GL stuff doesn't need docs for release, not a blocker there.

Orientation viewer isn't really any different from the previous one, just looks a little different. Absent help button isn't a blocker.

[lucas-wilkins]

I think the only thing that is a really a blocker is having docs that don't match actual software. Whilst having complete docs is nice, absent docs are not the kind of issue that should delay a release.

[lucas-wilkins]

Also, closing this as it's not how one uses the ticket system. Please see the https://github.com/orgs/SasView/discussions/2193 for what constitutes an issue. This contains many issues, which means it does not form a single, clear, actionable work package.