Skip to content

Commit 55fcaae

Browse files
borkwebborkweb
committed
Adding comments to methods
1 parent 6250aee commit 55fcaae

6 files changed

Lines changed: 585 additions & 57 deletions

File tree

‎.editorconfig‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# https://editorconfig.org/
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
end_of_line = lf
11+
charset = utf-8
12+
13+
[*.py]
14+
max_line_length = 88
15+
ensure_newline_before_comments = true
16+
include_trailing_comma = true
17+
use_parentheses = true
18+
19+
# Use 2 spaces for the HTML files
20+
[*.html]
21+
indent_size = 2
22+
23+
# The JSON files contain newlines inconsistently
24+
[*.json]
25+
indent_size = 2
26+
insert_final_newline = false
27+
28+
# Minified JavaScript files shouldn't be changed
29+
[**.min.js]
30+
indent_style = unset
31+
insert_final_newline = false
32+
33+
# Makefiles always use tabs for indentation
34+
[Makefile]
35+
indent_style = tab
36+
37+
# Batch files use tabs for indentation
38+
[*.bat]
39+
indent_style = tab
40+
41+
[docs/**.txt]
42+
max_line_length = 88
43+
44+
[*.yml]
45+
indent_size = 2

‎README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ArrayUtils (Arr)
2+
3+
[![Tests](https://github.com/borkweb/python-arrayutils/workflows/Tests/badge.svg)](https://github.com/borkweb/python-arrayutils/actions?query=branch%3Amain)
4+
5+
A library for array manipulations.
6+
7+
## Table of contents
8+
9+
* [Installation](#installation)
10+
* [Usage](#usage)
11+
12+
## Installation
13+
14+
Install arrayutils via pip:
15+
16+
```bash
17+
pip install arrayutils
18+
```
19+
20+
## Usage
21+
22+
Here are descriptions and usage examples for each method in the `Arr` class that you can get by:
23+
24+
```python
25+
from arrayutils import Arr
26+
```
27+

0 commit comments

Comments
 (0)