Skip to content

Commit 65349d2

Browse files
committed
Update markdown files with linting suggestions
1 parent 7b036de commit 65349d2

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
63+
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118118
version 2.0, available at
119-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120120

121121
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122122
enforcement ladder](https://github.com/mozilla/diversity).
123123

124124
[homepage]: https://www.contributor-covenant.org
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127-
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ Any table which name follows the format `tool.poetry[.group.{group_name}].depend
2828

2929
For running any of the following commands, position your shell in the project root, where `pyproject.toml` is located.
3030

31-
```
32-
$ poetry install # Install all dependencies, including test and dev
33-
$ poetry install --without test,dev # Install all dependencies, except those in groups test and dev
34-
$ poetry shell # Enters the environment shell
35-
$ poetry run <command> # Runs a command in the environment without having to open the shell. For example `poetry run pytest`
36-
$ poetry update [package_1] [package_2] # Update all the dependencies, or those specified to the latest compatible version
37-
$ poetry remove <package> [--group G] # Remove the listed package, optionally from a specific group
38-
$ poetry show # List all dependencies
39-
$ poetry config --list # Shows the current Pyproject configuration
40-
$ poetry export -f requirements.txt --output requirements.txt # Export all dependencies to requirements.txt file
31+
```bash
32+
poetry install # Install all dependencies, including test and dev
33+
poetry install --without test,dev # Install all dependencies, except those in groups test and dev
34+
poetry shell # Enters the environment shell
35+
poetry run <command> # Runs a command in the environment without having to open the shell. For example `poetry run pytest`
36+
poetry update [package_1] [package_2] # Update all the dependencies, or those specified to the latest compatible version
37+
poetry remove <package> [--group G] # Remove the listed package, optionally from a specific group
38+
poetry show # List all dependencies
39+
poetry config --list # Shows the current Pyproject configuration
40+
poetry export -f requirements.txt --output requirements.txt # Export all dependencies to requirements.txt file
4141
```
4242

4343
For more detailed use cases, and other commands, please visit the [cli documentation](https://python-poetry.org/docs/cli/).
@@ -80,7 +80,7 @@ To make changes to this repo, submit a Pull Request to the `dev` branch. Once it
8080

8181
As of now, we have a basic CI setup that can be checked here: [check.yaml](./.github/workflows/check.yaml). This setup can help you know if some tests are failing for your changes and that you need to make some changes before submitting the Pull Request.
8282

83-
#### Notes on commits:
83+
#### Notes on commits
8484

8585
We would like to have some naming standards on commits. We are going to try as much as we can to use the following format when naming our commits:
8686

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ practical applications. Designed to be used as consulting material for those who
55

66
Here is a checklist of the Data Structures and Algorithms we have or we are planning to add. If you would like to add more to the checklist, just create a Pull Request with your additions and we will review it.
77

8-
## Data Structures:
8+
## Data Structures
99

1010
- [x] [Stack](./data_structures/stack/implementation.py)
1111
- [x] [Trie](./data_structures/trie/implementation.py)
@@ -14,9 +14,9 @@ Here is a checklist of the Data Structures and Algorithms we have or we are plan
1414
- [x] [Graphs](./data_structures/graphs/implementation.py)
1515
- [x] [Linked List](./data_structures/linked_list/implementation.py)
1616

17-
## Algorithms:
17+
## Algorithms
1818

19-
### Sorting Algorithms:
19+
### Sorting Algorithms
2020

2121
- [x] [Bubble Sort](./algorithms/sorting/bubblesort.py)
2222
- [x] [Heap Sort](./algorithms/sorting/heapsort.py)
@@ -31,7 +31,7 @@ Here is a checklist of the Data Structures and Algorithms we have or we are plan
3131
- [ ] Tim Sort
3232
- [x] [Gnome Sort](./algorithms/sorting/gnome_sort.py)
3333

34-
### Search Algorithms:
34+
### Search Algorithms
3535

3636
- [x] [Linear Search](./algorithms/searching/linear_search.py)
3737
- [ ] Binary Search
@@ -60,7 +60,7 @@ Here is a checklist of the Data Structures and Algorithms we have or we are plan
6060
- [ ] Simpson
6161
- [ ] Fast Fourier Transform
6262

63-
### Graph Algorithms:
63+
### Graph Algorithms
6464

6565
- [ ] Breadth-First Search
6666
- [ ] Depth-First Search

0 commit comments

Comments
 (0)