Skip to content

Table.read and Table.write should provide useful docstrings #1011

Description

@eteq

Right now, if I do Table.read? in ipython, I get:

Definition: Table.read(cls, *args, **kwargs)
Docstring:
Read in data

The arguments passed to this method depend on the format

Which doesn't really help a user at all. Ideally, there would be at least a list of formatters (perhaps auto-generate from the registry like what is done in #961 ?) that I can then import and look at the docstrings of to figure out what the valid arguments are.

(cc @taldcroft - maybe you're already thinking about this as part of #961?)

Metadata

Metadata

Assignees

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions