diff options
author | Norbert Preining <norbert@preining.info> | 2021-07-24 03:01:03 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2021-07-24 03:01:03 +0000 |
commit | 9c5706814f2f593a9f52c51ad02b61e9bacd9ee4 (patch) | |
tree | fd31ea72f451724d8ad7908c945f0f6a40cdcda9 /support/latexindent/documentation/sec-conclusions-know-limitations.tex | |
parent | 9e46b83b2d49ad6f5d4285266a81c9af1dd3d74e (diff) |
CTAN sync 202107240301
Diffstat (limited to 'support/latexindent/documentation/sec-conclusions-know-limitations.tex')
-rw-r--r-- | support/latexindent/documentation/sec-conclusions-know-limitations.tex | 25 |
1 files changed, 6 insertions, 19 deletions
diff --git a/support/latexindent/documentation/sec-conclusions-know-limitations.tex b/support/latexindent/documentation/sec-conclusions-know-limitations.tex index 5f20a13d17..938a0d6f53 100644 --- a/support/latexindent/documentation/sec-conclusions-know-limitations.tex +++ b/support/latexindent/documentation/sec-conclusions-know-limitations.tex @@ -3,29 +3,16 @@ There are a number of known limitations of the script, and almost certainly quite a few that are \emph{unknown}! - The main limitation is to do with the alignment routine discussed in - \cpageref{lst:aligndelims:advanced}; for example, consider the file given in \cref{lst:matrix2}. - - \cmhlistingsfromfile{demonstrations/matrix2.tex}{\texttt{matrix2.tex}}{lst:matrix2} - - The default output is given in \cref{lst:matrix2-default}, and it is clear that the alignment - routine has not worked as hoped, but it is \emph{expected}. \cmhlistingsfromfile{demonstrations/matrix2-default.tex}{\texttt{matrix2.tex} default output}{lst:matrix2-default} - - The reason for the problem is that when \texttt{latexindent.pl} stores its code blocks - (see \vref{tab:code-blocks}) it uses replacement tokens. The alignment routine is using - the \emph{length of the replacement token} in its measuring -- I hope to be able to address this in the - future. - - There are other limitations to do with the multicolumn alignment routine (see - \vref{lst:tabular2-mod2}); in particular, when working with code blocks in which - multicolumn commands overlap, the algorithm can fail. + For example, with reference to the multicolumn alignment routine in + \vref{lst:tabular2-mod2}), when working with code blocks in which multicolumn commands + overlap, the algorithm can fail. Another limitation is to do with efficiency, particularly when the \texttt{-m} switch is active, as this adds many checks and processes. The current implementation relies upon finding and storing \emph{every} code block (see the discussion on - \cpageref{page:phases}); it is hoped that, in a future version, only - \emph{nested} code blocks will need to be stored in the `packing' phase, and - that this will improve the efficiency of the script. + \cpageref{page:phases}); I hope that, in a future version, only \emph{nested} code + blocks will need to be stored in the `packing' phase, and that this will improve the + efficiency of the script. You can run \texttt{latexindent} on any file;% \announce{2019-07-13}*{ability to call latexindent on any file} if you don't specify an extension, then the extensions that you |