Skip to content

Commit

Permalink
docs: improve notes
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Oct 5, 2023
1 parent b4686cd commit 239a2fb
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions src/dask_awkward/lib/inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ def report_necessary_buffers(
Returns
-------
dict[str, NecessaryBuffers | None]
Mapping that pairs the input layers in the graph to the
typetracer report objects that have been populated by column
optimisation of the given layer.
Mapping that pairs the input layers in the graph to objects
describing the data and shape buffers that have been tagged
as required by column optimisation of the given layer.
Examples
--------
If we have a hypothetical parquet dataset (``ds``) with the fields
Expand Down Expand Up @@ -147,11 +147,9 @@ def report_necessary_columns(
>>> ds.baz.fields
["x", "y"]
>>> x = ds.bar + ds.baz.x
>>> dak.report_necessary_buffers(x)
>>> dak.report_necessary_columns(x)
{
"from-parquet-abc123": NecessaryBuffers(
data_and_shape=frozenset(...), shape_only=frozenset(...)
)
"from-parquet-abc123": frozenset({"bar", "baz.x"})
}
"""
Expand Down

0 comments on commit 239a2fb

Please sign in to comment.