Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
-updated `custom_operation()` docstring in README.md
  • Loading branch information
jianfch committed Nov 27, 2024
1 parent 08421e2 commit 9fe1bf5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1134,6 +1134,7 @@ result.reset()
result.regroup(history)
```
_Note: `regroup_history` from operations that use non-primitive types (e.g. functions) for arguments cannot be used on another result_
<br>
Any regrouping algorithm can be expressed as a string. Please feel free share your strings [here](https://github.com/jianfch/stable-ts/discussions/162).
#### Regrouping Methods
<details>
Expand Down Expand Up @@ -1519,7 +1520,8 @@ Docstrings:
Parameters
----------
key : str
Attribute of words/segments to get value of.
Attribute of words/segments to get value for comparing with ``value``.
If ``key`` is empty string, directly use the instance of ``WordTiming``/``Segment`` object for comparison.
All " " in ``key`` will be replaced with "_".
Start with "len=" to get length of the attribute.
operator : str or Callable
Expand Down

0 comments on commit 9fe1bf5

Please sign in to comment.