Skip to content

Commit

Permalink
client: improve init_columns docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaume committed Aug 5, 2021
1 parent a154302 commit d679246
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions mpcontribs-client/mpcontribs/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -722,9 +722,12 @@ def init_columns(self, name: str, columns: dict) -> dict:
values for the affected data fields will be respected.
The `columns` argument is a dictionary which maps the data field names to its
units. Use `None` to indicate that a field doesn't have a unit. The unit for a
dimensionless quantity is an empty string (""). Nested fields are indicated using
a dot (".") in the data field name. Example:
units. Use `None` to indicate that a field is not a quantity (plain string). The
unit for a dimensionless quantity is an empty string (""). Percent (`%`) and
permille (`%%`) are considered units. Nested fields are indicated using a dot
(".") in the data field name.
Example:
>>> client.init_columns("sandbox", {"a": None, "b.c": "eV", "b.d": "mm", "e": ""})
Expand Down

0 comments on commit d679246

Please sign in to comment.