Skip to content

Commit

Permalink
Format names of function parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
samer-hamood committed Jan 25, 2025
1 parent ef2b2f3 commit c9e0bb3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,11 +368,11 @@ complete documentation reference
| `zip_with_index(start=0)` | Zips the sequence with the index starting at `start` on the right side | transformation |
| `enumerate(start=0)` | Zips the sequence with the index starting at `start` on the left side | transformation |
| `cartesian(*iterables, repeat=1)` | Returns cartesian product from itertools.product | transformation |
| `inner_join(other)` | Returns inner join of sequence with other. Must be a sequence of `(key, value)` pairs | transformation |
| `outer_join(other)` | Returns outer join of sequence with other. Must be a sequence of `(key, value)` pairs | transformation |
| `left_join(other)` | Returns left join of sequence with other. Must be a sequence of `(key, value)` pairs | transformation |
| `right_join(other)` | Returns right join of sequence with other. Must be a sequence of `(key, value)` pairs | transformation |
| `join(other, join_type='inner')` | Returns join of sequence with other as specified by `join_type`. Must be a sequence of `(key, value)` pairs | transformation |
| `inner_join(other)` | Returns inner join of sequence with `other`. Must be a sequence of `(key, value)` pairs | transformation |
| `outer_join(other)` | Returns outer join of sequence with `other`. Must be a sequence of `(key, value)` pairs | transformation |
| `left_join(other)` | Returns left join of sequence with `other`. Must be a sequence of `(key, value)` pairs | transformation |
| `right_join(other)` | Returns right join of sequence with `other`. Must be a sequence of `(key, value)` pairs | transformation |
| `join(other, join_type='inner')` | Returns join of sequence with `other` as specified by `join_type`. Must be a sequence of `(key, value)` pairs | transformation |
| `partition(func)` | Partitions the sequence into elements that satisfy `func(element)` and those that don't | transformation |
| `grouped(size)` | Partitions the elements into groups of size `size` | transformation |
| `sorted(key=None, reverse=False)/order_by(func)` | Returns elements sorted according to python `sorted` | transformation |
Expand Down Expand Up @@ -405,8 +405,8 @@ complete documentation reference
| `dict(default=None)` / `to_dict(default=None)` | Converts a sequence of `(Key, Value)` pairs to a `dictionary`. If `default` is not None, it must be a value or zero argument callable which will be used to create a `collections.defaultdict` | action |
| `list()` / `to_list()` | Converts sequence to a list | action |
| `set() / to_set()` | Converts sequence to a set | action |
| `to_file(path)` | Saves the sequence to a file at path with each element on a newline | action |
| `to_csv(path)` | Saves the sequence to a csv file at path with each element representing a row | action |
| `to_file(path)` | Saves the sequence to a file at `path` with each element on a newline | action |
| `to_csv(path)` | Saves the sequence to a csv file at `path` with each element representing a row | action |
| `to_jsonl(path)` | Saves the sequence to a jsonl file with each element being transformed to json and printed to a new line | action |
| `to_json(path)` | Saves the sequence to a json file. The contents depend on if the json root is an array or dictionary | action |
| `to_sqlite3(conn, tablename_or_query, *args, **kwargs)` | Saves the sequence to a SQLite3 db. The target table must be created in advance | action |
Expand Down

0 comments on commit c9e0bb3

Please sign in to comment.