sw_plotspec sortMode documentation/code discrepancy

[g5t]

spinw/swfiles/sw_plotspec.m

Lines 74 to 76 in 62308ee

	% `'sortMode'`
	% : Sorting the modes before plotting. Default is `false`. Can improve the
	% quality of the dispersion line plots if modes are crossing.

spinw/swfiles/sw_plotspec.m

Lines 193 to 194 in 62308ee

	inpForm.fname = [inpForm.fname {'lineStyle' 'lineWidth' 'sortMode'}];
	inpForm.defval = [inpForm.defval {{'-' 'o-' '--'} 0.5 true }];

The default setting for 'sortMode' contradicts the documentation in sw_plotspec. While changing the documentation would solve the discrepancy, I think that changing the default to match the documentation is the better solution as it fixes the mode labeling issue for incommensurate orders.

Furthermore, the optional flag 'sortMode' for sw_plotspec and, e.g., spinwave, have different meanings -- the first numerically sorts the mode energies at each Q to avoid plotted-crossings, while the second uses mode continuity at a crossing to assign energies to modes. Switching one or both flag names might help avoid any future confusion regarding what each does.

[wardsimon]

Hey! Thanks for the input and documentation checking :-)
I'll correct the documentation for the default option of sortMode in sw_plotspec. As a compromise I'll extend the sortMode documentation to clarify the sorting methods as changing the option could cause errors on existing scripts. Or, I'll implement both and give a depreciation warning.