Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Tty): improve documentation #183

Merged
merged 1 commit into from
Oct 31, 2024
Merged

docs(Tty): improve documentation #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/tty/Tty.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

(** The type of custom marker functions. A marker function takes the following three arguments:
+ [ansi]: whether ANSI escape sequences are enabled, and if so, whether colors are used.
+ The mark's target message: [`Main_message] is the main message, and [`Extra_remark i] is the [i]th extra remark in the diagnostic.
+ The mark's target message: [`Main_message] is the main message, and [`Extra_remark i] is the [i]th extra remark in the diagnostic. The indexes of the extra remarks begin at zero and follow the original order in the input list (despite the use of backward lists in the definition of diagnostics).
+ Whether the mark indicates the start or end of a non-empty range, or the location of a point (an empty range), and whether the mark is at the end of a line or a file.
The output is the string to visualize the mark within the source text.

Expand Down