Skip to content

Commit 124c38a

Browse files
committed
Document Omit in Overview; minor adjustments
1 parent d525112 commit 124c38a

File tree

3 files changed

+18
-7
lines changed

3 files changed

+18
-7
lines changed

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright © 2016,2018 Pennock Tech, LLC
3+
Copyright © 2016,2018,2025 Pennock Tech, LLC
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Overview.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -277,12 +277,19 @@ appropriately within tabular itself.
277277
+ Skipability:
278278
- `Skipable` is the property key, value must be a boolean
279279
- non-boolean values may result in panic
280-
- currently only a column property, and is permitted to be used by
281-
renderers to control whether or not to skip a column entirely,
282-
or for the JSON rendered to skip including a field for items in that
283-
column if empty.
284-
+ At present, is only used by JSON, have not yet implemented a
285-
multiple-pass system to let it be used for entire-column suppression.
280+
- currently only a column property, used by JSON to indicate to skip
281+
fields in that column, if and only if those cells are empty.
282+
+ Omission:
283+
- `Omit` is the property key, value must be a boolean
284+
- indicates that the affected item should not be rendered, at all, no
285+
matter the value
286+
- is currently only a column property, may be extended to rows in the
287+
future
288+
- is supported by all renderers
289+
- all renderers support this property being on Column 0 (the defaults
290+
pseudo-column) to set a default for the table's columns, such that this
291+
bool can be set explicitly false on some columns to only render those
292+
columns.
286293
* `go.pennock.tech/tabular/properties/align`
287294
+ controls for text alignment; currently this is limited to very simplistic
288295
`Left`, `Center` and `Right` values, which may be used as values for the

doc.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ Sub-packages provide for rendering a TextTable which is designed for a
1111
fixed-cell grid layout of character cells, such as a Unix TTY; for rendering as
1212
an HTML table; for rendering as a CSV.
1313
14+
Most clients doing table rendering should probably import
15+
"go.pennock.tech/tabular/auto" and use `auto.New("texttable")` to get an object
16+
which can be easily rendered.
17+
1418
The core package provides a Table interface; each sub-package embeds a Table in
1519
their own core object, so all methods in the Table interface can be directly
1620
used upon such objects. These provide for your basic addition of cells, etc.

0 commit comments

Comments
 (0)