Repository navigation
Add doc for function background - #55
Open
StephenNneji wants to merge 2 commits into
Open
StephenNneji wants to merge 2 commits into
StephenNneji wants to merge 2 commits into
Conversation
StephenNneji
force-pushed
the
update_docs
branch
from
October 2, 2026 11:43
b7f7ec8 to
92c172b
Compare
DrPaulSharp
reviewed
Oct 5, 2026
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: '3.11' | ||
| python-version: '3.10' |
Collaborator
There was a problem hiding this comment.
Why has the python version been downgraded? Is this a good idea since version 3.10 has just gone end-of-life? https://devguide.python.org/versions/
| Function Backgrounds | ||
| ==================== | ||
|
|
||
| RAT supports function backgrounds which use a custom function to describe the background for the experiment. |
Collaborator
There was a problem hiding this comment.
I think this might read better with a comma, as: "RAT supports function backgrounds, which use a custom function to describe the background for the experiment. "
|
|
||
| The signature for background functions is shown in the code snippet below. The first argument `xdata` is a vector containing the q points over the simulation range, | ||
| which should incorporate the q values of the supplied data and the second argument `params` is a vector containing the background parameters associated with the background | ||
| up to 5 can be related to a specific functoin background. The function should return an array with the background value for each of the input simulation points. |
Collaborator
There was a problem hiding this comment.
"and the second argument params is a vector containing the background parameters associated with the background up to 5 can be related to a specific functoin background."
Typo in "function". Also it feels like there is some punctuation missing here.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#54