Skip to content

Commit

Permalink
📚 Add documentation for auto back-end inference
Browse files Browse the repository at this point in the history
Closes #40
  • Loading branch information
ronisbr committed Feb 1, 2020
1 parent fff0c0f commit 0dcf522
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/src/man/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ Each back-end defines its own configuration keywords that can be passed using
* `filters_row`: Filters for the rows (see the section `Filters`).
* `filters_col`: Filters for the columns (see the section `Filters`).

!!! note

Notice that all back-ends have the keyword `tf` to specify the table
printing format. Thus, if the keyword `backend` is not present or if it is
`nothing`, then the back-end will be automatically inferred from the type of
the keyword `tf`. In this case, if `tf` is also not present, then it just
fall-back to the text back-end.

# Examples

In the following, it is possible to see some examples for a quick start using
Expand Down
8 changes: 8 additions & 0 deletions src/print.jl
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ it is not compliant, then only the following types are supported:
* `filters_row`: Filters for the rows (see the section `Filters`).
* `filters_col`: Filters for the columns (see the section `Filters`).
!!! note
Notice that all back-ends have the keyword `tf` to specify the table
printing format. Thus, if the keyword `backend` is not present or if it is
`nothing`, then the back-end will be automatically inferred from the type of
the keyword `tf`. In this case, if `tf` is also not present, then it just
fall-back to the text back-end.
# Alignment
The keyword `alignment` can be a `Symbol` or a vector of `Symbol`.
Expand Down

0 comments on commit 0dcf522

Please sign in to comment.