Fix docs (Duc assigned) #1614
Open
Fix docs (Duc assigned) #1614
Conversation
This file contains 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
mducle
added
documentation
mducle
commented
Jul 25, 2024
| Generating data | ||
| =============== | ||
| Generating the data | ||
| =================== |
There was a problem hiding this comment.
This is to avoid a warning that there as a duplicate section title Generating data below.
documentation/user_docs/docs/manual/Correcting_for_sample_misalignment.rst
Show resolved
Hide resolved
| - :ref:`IX_dataset_3d <manual/Changing_object_type:IX_dataset_3d>` | ||
| .. - :ref:`IX_dataset_1d <manual/Changing_object_type:IX_dataset_1d>` | ||
| .. - :ref:`IX_dataset_2d <manual/Changing_object_type:IX_dataset_2d>` | ||
| .. - :ref:`IX_dataset_3d <manual/Changing_object_type:IX_dataset_3d>` |
There was a problem hiding this comment.
@cmarooney-stfc Duly removed...
oerc0122
requested changes
Jul 26, 2024
documentation/user_docs/docs/manual/Correcting_for_sample_misalignment.rst
Show resolved
Hide resolved
documentation/user_docs/docs/user_guide/Interfacing_with_other_programs.rst
Outdated
Show resolved
Hide resolved
documentation/user_docs/docs/user_guide/Interfacing_with_other_programs.rst
Outdated
Show resolved
Hide resolved
documentation/user_docs/docs/user_guide/Interfacing_with_other_programs.rst
Outdated
Show resolved
Hide resolved
documentation/user_docs/docs/user_guide/Interfacing_with_other_programs.rst
Outdated
Show resolved
Hide resolved
Co-authored-by: Jacob Wilkins <[email protected]>
oerc0122
approved these changes
Jul 26, 2024
cmarooney-stfc
requested changes
Aug 9, 2024
| @@ -263,9 +259,9 @@ to add them together. In this case, you may decrease time of your ``plus`` opera | |||
| w_bg = sqw_eval(my_cut,@my_background,background_parameters); | |||
| w_sum = binary_op_manager(w_fg,w_bg,@plus,true); | |||
|
|
|||
| Last parameter of ``binary_op_manager`` set to ``true`` disables sorting pixels in bins while performing binary operations. | |||
| If the last parameter of ``binary_op_manager`` is set to ``true`` it disables sorting pixels in bins while performing binary operations. | |||
There was a problem hiding this comment.
A cross-reference to the sorting operation applied would be useful
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes the docs I was assigned:
Edit: In addition I've cleaned up the links between sections and some formatting errors and also removed the old example scripts in the
manual/folder which was not linked to anywhere else (and has been superseded by theexample_scriptsfolder.