From 7cd95300066195ba0adc91019c8d7c7f0e6aadb5 Mon Sep 17 00:00:00 2001 From: Delyan Angelov Date: Fri, 27 Nov 2020 13:03:32 +0200 Subject: [PATCH] docs: fix most of the examples (ensure they at least have a valid syntax) --- .../building-a-simple-web-blog-with-vweb.md | 4 ++++ vlib/eventbus/README.md | 7 ++++--- vlib/regex/README.md | 4 ++-- vlib/term/README.md | 21 ++++++++++--------- 4 files changed, 21 insertions(+), 15 deletions(-) diff --git a/tutorials/building-a-simple-web-blog-with-vweb.md b/tutorials/building-a-simple-web-blog-with-vweb.md index 045d53bfdf..b04c7f5315 100644 --- a/tutorials/building-a-simple-web-blog-with-vweb.md +++ b/tutorials/building-a-simple-web-blog-with-vweb.md @@ -96,6 +96,7 @@ Vweb often uses convention over configuration and adding a new action requires no routing rules either: ```v oksyntax +import vweb fn (mut app App) time() vweb.Result { app.vweb.text(time.now().format()) return vweb.Result{} @@ -206,6 +207,7 @@ Add a SQLite handle to `App`: ```v oksyntax import sqlite +import vweb struct App { pub mut: @@ -332,6 +334,7 @@ Create `new.html`: ``` ```v oksyntax +import vweb pub fn (mut app App) new_article() vweb.Result { title := app.vweb.form['title'] text := app.vweb.form['text'] @@ -370,6 +373,7 @@ to render everything on the client or need an API, creating JSON endpoints in V is very simple: ```v oksyntax +import vweb pub fn (mut app App) articles() vweb.Result { articles := app.find_all_articles() app.vweb.json(json.encode(articles)) diff --git a/vlib/eventbus/README.md b/vlib/eventbus/README.md index bac5c06605..7aebe6f025 100644 --- a/vlib/eventbus/README.md +++ b/vlib/eventbus/README.md @@ -30,7 +30,7 @@ A module to provide eventing capabilities using pub/sub. The function given to `subscribe`, `subscribe_method` and `subscribe_once` must match this: ```v oksyntax -fn(receiver voidptr, args voidptr, sender voidptr) { +fn cb(receiver voidptr, args voidptr, sender voidptr) { } // Since V can map structs to voidptr, this also works @@ -40,7 +40,7 @@ struct ClickEvent { } // Example case where publisher sends ClickEvent as args. -fn onPress(receiver voidptr, e &ClickEvent, sender voidptr){ +fn on_press(receiver voidptr, e &ClickEvent, sender voidptr){ println(e.x) //your code here... } @@ -48,7 +48,8 @@ fn onPress(receiver voidptr, e &ClickEvent, sender voidptr){ ## Usage -For **usage across modules** [check the example](https://github.com/vlang/v/tree/master/examples/eventbus). +For **usage across modules** +[check the example](https://github.com/vlang/v/tree/master/examples/eventbus). _Note: As a general rule, you will need to **subscribe before publishing**._ diff --git a/vlib/regex/README.md b/vlib/regex/README.md index 7ef4def943..86062f0798 100644 --- a/vlib/regex/README.md +++ b/vlib/regex/README.md @@ -410,7 +410,7 @@ pub fn new() RE pub fn new_by_size(mult int) RE ``` After a base initializer is used, the regex expression must be compiled with: -```v oksyntax +```v ignore // compile compiles the REgex returning an error if the compilation fails pub fn (re mut RE) compile_opt(in_txt string) ? ``` @@ -419,7 +419,7 @@ pub fn (re mut RE) compile_opt(in_txt string) ? These are the operative functions -```v oksyntax +```v ignore // match_string try to match the input string, return start and end index if found else start is -1 pub fn (re mut RE) match_string(in_txt string) (int,int) diff --git a/vlib/term/README.md b/vlib/term/README.md index c07cfa8845..e73cc8ef12 100644 --- a/vlib/term/README.md +++ b/vlib/term/README.md @@ -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.(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_(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()