Skip to content

Commit

Permalink
Document default Table.meta as dict
Browse files Browse the repository at this point in the history
  • Loading branch information
dhomeier committed Nov 5, 2024
1 parent 56e36f2 commit 8a120f5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/table/access_table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Accessing Properties

The code below shows accessing the table columns as a |TableColumns| object,
getting the column names, table metadata, and number of table rows. The table
metadata is an `~collections.OrderedDict` by default.
metadata is a :class:`dict` by default.
::

>>> t.columns
Expand Down
6 changes: 3 additions & 3 deletions docs/table/construct_table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -720,10 +720,10 @@ meta
----

The ``meta`` argument is an object that contains metadata associated with the
table. It is recommended that this object be a :class:`dict` or
:class:`~collections.OrderedDict`, but the only firm requirement is that it can
table. It is recommended that this object be a :class:`dict`, but the
only firm requirement is that it *must be a dict-like mapping* and can
be copied with the standard library :func:`copy.deepcopy` routine. By
default, ``meta`` is an empty :class:`~collections.OrderedDict`.
default, ``meta`` is an empty :class:`dict`.

copy
----
Expand Down

0 comments on commit 8a120f5

Please sign in to comment.