Skip to content

Commit

Permalink
docs: conventions, mwe and docstring fixes (#3973)
Browse files Browse the repository at this point in the history
  • Loading branch information
thatlittleboy committed Jul 11, 2022
1 parent deac4b9 commit 35bb7bf
Show file tree
Hide file tree
Showing 9 changed files with 227 additions and 294 deletions.
3 changes: 1 addition & 2 deletions py-polars/docs/source/reference/expression.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,6 @@ Manipulation/ selection

Expr.append
Expr.arg_sort
Expr.arg_sort
Expr.argsort
Expr.backward_fill
Expr.cast
Expand Down Expand Up @@ -220,7 +219,7 @@ Column names
------------
Expressions that help renaming/ selecting columns by name.

A wildcard `col("*")`/`pl.all()` selects all columns in a DataFrame.
A wildcard ``col("*")``/:func:`polars.all()` selects all columns in a DataFrame.

>>> df.select(pl.all())

Expand Down
1 change: 0 additions & 1 deletion py-polars/polars/cfg.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ def set_tbl_cols(cls, n: int) -> type[Config]:
Examples
--------
>>> pl.cfg.Config.set_tbl_cols(5)
>>> df = pl.DataFrame({str(i): [i] for i in range(100)})
>>> df
Expand Down
3 changes: 0 additions & 3 deletions py-polars/polars/convert.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,6 @@ def from_dicts(
Examples
--------
>>> data = [{"a": 1, "b": 4}, {"a": 2, "b": 5}, {"a": 3, "b": 6}]
>>> df = pl.from_dicts(data)
>>> df
Expand Down Expand Up @@ -136,7 +135,6 @@ def from_records(
Examples
--------
>>> data = [[1, 2, 3], [4, 5, 6]]
>>> df = pl.from_records(data, columns=["a", "b"])
>>> df
Expand Down Expand Up @@ -193,7 +191,6 @@ def from_numpy(
Examples
--------
>>> import numpy as np
>>> data = np.array([[1, 2, 3], [4, 5, 6]])
>>> df = pl.from_numpy(data, columns=["a", "b"], orient="col")
Expand Down

0 comments on commit 35bb7bf

Please sign in to comment.