Fix: Break line properly into latex when next line starts with `_`

Description

After this MR the slurm profile name was changed from 'slurm_prof_t230419_133346.736582_0' to 'slurm_prof_230419_133346.736582_0' this lead to a pdflatex error while creating the reports for DSSC dark and correct.

After the MR suggestions, the tex_escape and split_len have been swapped around while converting the parameter values.

How Has This Been Tested?

This was tested with DSSC dark and correct reference runs.

Relevant Documents (optional)

Types of changes

• Bug fix (non-breaking change which fixes an issue)

Checklist:

• My code follows the code style of this project.
• I have updated the documentation accordingly.

Reviewers

@kluyvert @schmidtp

changed milestone to %3.11.0

added Waiting for review label

assigned to @ahmedk

Thanks for figuring that out. It looks like there's also a function tex_escape() which also includes replacing '_' with '\_', but it's called before the split_len() function, so it gets split between the \ and _.

I wonder if a neater fix is to swap the order round, so we do split_len() first and then tex_escape()? There are other escapes which are even longer, e.g. '\textasciitilde{}', and I imagine splitting in the middle of those would also be a problem.

Please feel free to make an issue for this idea, but this seems somewhat required if we want to deploy today without reverting !871 (merged), so I'd take this solution for now.

LGTM.

Sorry It took me some time I was running the other tests. I have swapped split_len and tex_excape and tested with DSSC dark and correct and both work

Nope it didn't work as I thought.

So the jobs succeeded but the report was messed up. I will revert to the first change and merge and open an issue to improve this later.

added 3 commits

• 2a9d9549...563b80eb - 2 commits from branch master
• 7c581a3a - break line properly into latex when next line starts with

Compare with previous version

added 2 commits

• 2a9d9549 - break line properly into latex when next line starts with
• 423dd907 - switch tex_excape with split_len for converting value to latex

Compare with previous version

added 1 commit

• 86954632 - update the docstring with corrected example

Compare with previous version

added 9 commits

• 86954632...b3e11b25 - 6 commits from branch master
• 393dfd06 - break line properly into latex when next line starts with
• 70da8615 - switch tex_excape with split_len for converting value to latex
• 58abee45 - update the docstring with corrected example

Compare with previous version

resolved all threads

changed the description

added 1 commit

• 3637c471 - revert back to the first commit 393dfd06

Compare with previous version

enabled an automatic merge when the pipeline for 3637c471 succeeds

canceled the automatic merge

merged

mentioned in commit b0d753ed