mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

docs: fix most of the examples (ensure they at least have a valid syntax)

Browse Source
This commit is contained in:
Delyan Angelov
2020-11-27 13:03:32 +02:00
parent e6116c47be
commit 7cd9530006
4 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
vlib/term/README.md
View File

@@ -41,39 +41,40 @@ This simple program covers many of the principal aspects of the `term ` module.
Here are some functions you should be aware of in the `term `module:
```v oksyntax
import term
// returns the height and the width of the terminal
term.get_terminal_size() (width, height)
width, height := term.get_terminal_size()
// returns the string as green text to be printed on stdout
term.ok_message(string)
term.ok_message('cool')
// returns the string as red text to be printed on stdout
term.fail_message(string)
term.fail_message('oh, no')
// returns the string as yellow text to be printed on stdout
term.warning_message(string)
term.warning_message('be warned')
//clears the entire terminal and leaves a blank one
term.clear()
// colors the output of the output, the available colors are: black,blue,yellow,green,cyan,gray,bright_blue,bright_green,bright_red,bright_black,bright_cyan
term.<color>(string)
term.yellow('submarine')
// transforms the given string into bold text
term.bold(string)
term.bold('and beautiful')
// puts a strikethrough into the given string
term.strikethrough(string)
term.strikethrough('the core of the problem')
// underlines the given string
term.underline(string)
term.underline('important')
// colors the background of the output following the given color
// the available colors are: black, blue, yellow, green, cyan, gray
term.bg_<color>(string)
term.bg_green('field')
// sets the position of the cursor at a given place in the terminal
term.set_cursor_position(term.Coord)
term.set_cursor_position(x: 5, y: 10)
// moves the cursor up
term.cursor_up()