📚 Add initial documentation related to the overwrite

ronisbr · Jun 1, 2020 · b62df93 · b62df93
1 parent 407ae3f
commit b62df93
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/src/man/text_backend.md b/docs/src/man/text_backend.md
@@ -83,6 +83,9 @@ passed as keywords when calling the function `pretty_table`:
 * `nosubheader`: If `true`, then the sub-header will not be printed, *i.e.* the
                  header will contain only one line. Notice that this option has
                  no effect if `noheader = true`. (**Default** = `false`)
+* `overwrite`: If `true`, then the same number of lines in the printed table
+               will be deleted from the output `io`. This can be used to update
+               the table in the screen continuously. (**Default** = `false`)
 * `same_column_size`: If `true`, then all the columns will have the same size.
                       (**Default** = `false`)
 * `screen_size`: A tuple of two integers that defines the screen size (num. of

diff --git a/src/print.jl b/src/print.jl
@@ -207,6 +207,9 @@ This back-end produces text tables. This back-end can be used by selecting
 * `nosubheader`: If `true`, then the sub-header will not be printed, *i.e.* the
                  header will contain only one line. Notice that this option has
                  no effect if `noheader = true`. (**Default** = `false`)
+* `overwrite`: If `true`, then the same number of lines in the printed table
+               will be deleted from the output `io`. This can be used to update
+               the table in the screen continuously. (**Default** = `false`)
 * `same_column_size`: If `true`, then all the columns will have the same size.
                       (**Default** = `false`)
 * `screen_size`: A tuple of two integers that defines the screen size (num. of