Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Wez Furlong <[email protected]>
  • Loading branch information
Danielkonge and wez committed Dec 3, 2023
1 parent 254034c commit e3cd2e9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/config/lua/wezterm/to_string.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ tags:
This function returns a string representation of any Lua value. In particular
this can be used to get a string representation of a table or userdata.

The intended purpose is as a human readable way to inspect lua values. It is not machine
readable; do not attempt to use it as a serialization format as the format is not guaranteed
to remain the same across different versions of wezterm.

This same representation is used in the [debug overlay](../keyassignment/ShowDebugOverlay.md
when printing the result of an expression from the Lua REPL and for the implicit string
conversions of the parameters passed to [wezterm.log_info](log_info.md).

```lua
local wezterm = require 'wezterm'
assert(wezterm.to_string { 1, 2 } == [=[[
Expand Down

0 comments on commit e3cd2e9

Please sign in to comment.