Commit cacff63
committed
docs: tighten hidden-attribute guidance — high bar, app-code heuristic
The previous "when to declare hidden" paragraph allowed too much: backing
an index was treated as sufficient reason to hide. It isn't. The clean
heuristic is: if application code touches the column (computes it,
inserts it, queries on it, wants it in describe() output), it should be
a regular attribute. Hidden is for platform/implementation concerns the
application code never references — _job_* populated by autopopulate
internals, _singleton's implementation pattern, or fields that would
actively interfere with natural-join semantics.
Use the params_hash-with-unique-index case as a concrete example of
when NOT to hide: even though it backs an index, the application code
computes and inserts the hash, so it should be regular and let proj()
handle visibility at the call site if needed.1 parent d2c0360 commit cacff63
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
225 | 225 | | |
226 | 226 | | |
227 | 227 | | |
228 | | - | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
229 | 231 | | |
230 | 232 | | |
231 | 233 | | |
| |||
0 commit comments