forked from ManimCommunity/manim
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit 8f8e4b1
Document and type utils/iterables.py (ManimCommunity#2649)
* 🎨 Reorder functions alphabetically
Makes it easier to reference documentation alongside source code.
* 🎨 Rename concatenate_lists to flatten_lists
This is more consistent with terminology online in terms of data science.
We're flattening a 2D list into a regular one.
* 🏷️ Add types to iterables.py
Some functions require just Iterables, others Collections (sized iterables), etc.
* 💡 Add docstrings and examples to 1st half of iterables.py
Improved the clarity of some existing explanations as well.
flatten_lists was reverted to concatenate lists on closer inspection.
* 🎨 Adjust docstring format to numpy style
Use Examples header and indent docstrings description consistent with
numpy style guide as well as Manim wiki guidance.
* 💡 Add docstrings and examples to 2nd half of iterables.py
Improved the clarity of some existing explanations as well and updated
formatting to match updated style.
* 💄 Sort __all__ in file head alphabetically
Matches order of functions in file.
Co-authored-by: Darylgolden <[email protected]>1 parent 5071e94 commit 8f8e4b1Copy full SHA for 8f8e4b1
File tree
Expand file treeCollapse file tree
1 file changed
+335
-93
lines changedFilter options
- manim/utils
Expand file treeCollapse file tree
1 file changed
+335
-93
lines changed
0 commit comments