texstudio-org / texstudio-org/texstudio

Long package error text is wrongly striped in "Issues panel"

Open
#658 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C++
Stars
3.6k
Forks
403
Avg merge
3h 14m
Merged PRs (30d)
12

Description

Environment
  • TeXstudio: 2.12.16
  • Qt: 5.12.3
  • OS: macOS 10.14.5
  • TeX distribution: mactex 2019
Actual behavior

Middle lines of long package error text is missing in "Issues panel"

How to reproduce
  1. Compile this tex file
\documentclass{article}
\begin{document}
\PackageError{x-pkg}{Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
adminim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
exeacommodo consequat}{}
\end{document}
  1. Then we can find full package error text in log file, and a shorten text in "Issues panel"

image

  1. Observe that the contents of shorten text is composed of:
% i) fist line of error message in full version, framed in blue in screenshot
Package x-pkg Error: Lorem ipsum dolor sit amet, consectetur adipiscing elit,

% ii) last line of error messge, framed in green
odo consequat. 

% iii) text after source line number, framed in yellow
exeacommodo consequat}{}
  1. That observation shows that middle lines of full version is missing in shorten version, and this may add difficulty to understanding shorten text. For example, this is a long error message produced by tikz
    image
Expected behavior

The Message column of Issues panel can show

  • first line of error message + [more letters from middle lines up to a max count of letters + ] "..." + text after source line number

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the embedded .tex example and compare the full log with the Issues panel’s Message column. Trace the existing shortening path from the issue-panel entry point; done when the first line, middle text up to the maximum, ellipsis, and text after the source line number are retained.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, latex
Domain
desktop
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.