Corfunc Docs

[lucas-wilkins]

New corfunc docs, see #2674 for details.

[smk78]

This is a nice set of documentation. I can see the Theory one becoming a quasi-primary reference once it's discoverable!

A few things I spotted:

In corfunc-theory:
In Overview:
Typo: In "such that there is no spatial correlations between particles" replace "is" by "are"
In Formal Description:
"t" and "s" are undefined
In the Gamma1 projection:
Typo: "This the case" should presumably be "This is the case"?
In the Gamma3 projection:
Typo: "stradians" should be "steradians"
In the second equation phi is undefined
The equation under the line "Where phi is a solid angle element" needs reformatting as it incorporates some text

In corfunc-technical:
In Transformation:
Could give the equation for Q*, I guess?
In Interpretation:
Can we give the definition of the Stribeck polydispersity

In corfunc-how-to:
In Options:
Typo: In "where there is small errors in the transformed data" replace "is" by "are"
Typo: In "such as hard block is calculated" replace "is" by "are"
In Output:
Please could we add a note warning that if the transformed data CSV file is read back into SasView it will be interpreted as (Q,I(Q),dI,dQ)!!!

[smk78]

Functionality test on W10/x64 of Github Actions build 8294510082.

All good and doing as expected... until I clicked on the floppy disk in the plot navigation menu to save the plot, whereupon this popped up in the Log Explorer:

ERROR: Traceback (most recent call last): File "matplotlib\backends\backend_qt.py", line 783, in save_figure TypeError: 'CorfuncWindow' object is not callable

[smk78]

Looking good! Just a few documentation issues and (unfortunately) a bug saving plots.
See Conversation for details.

[lucas-wilkins]

This is a nice set of documentation. I can see the Theory one becoming a quasi-primary reference once it's discoverable!

A few things I spotted:

In corfunc-theory: In Overview: Typo: In "such that there is no spatial correlations between particles" replace "is" by "are" In Formal Description: "t" and "s" are undefined In the Gamma1 projection: Typo: "This the case" should presumably be "This is the case"? In the Gamma3 projection: Typo: "stradians" should be "steradians" In the second equation phi is undefined The equation under the line "Where phi is a solid angle element" needs reformatting as it incorporates some text

All done

In corfunc-technical: In Transformation: Could give the equation for Q*, I guess? In Interpretation: Can we give the definition of the Stribeck polydispersity

Opened new issue for these - #2835

In corfunc-how-to: In Options: Typo: In "where there is small errors in the transformed data" replace "is" by "are" Typo: In "such as hard block is calculated" replace "is" by "are" In Output: Please could we add a note warning that if the transformed data CSV file is read back into SasView it will be interpreted as (Q,I(Q),dI,dQ)!!!

Done

[smk78]

This PR is now suitable to merge. But note #2835

[butlerpd]

The only failure is the apple notarization which is likely to continue until we can fix the CI for that. Is there a reason we should not merge this approved documentation change?