Skip to content

Commit fba1039

Browse files
committed
📚 Fix inconsistencies in code snippets
1 parent 099da05 commit fba1039

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

‎docs/documentation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ This command:
207207
Your documentation will be available at:
208208

209209
```
210-
https://<username>.github.io/dev-tutorial-<username>/
210+
https://<YOUR_USERNAME>.github.io/dev-tutorial-<YOUR_USERNAME>/
211211
```
212212

213213
For example, this documentation is hosted at: [https://mbercx.github.io/softdev-101/](https://mbercx.github.io/softdev-101/)

‎docs/formatting.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ ruff check
119119

120120
```console {.no-copy}
121121
F841 Local variable `debug_mode` is assigned to but never used
122-
--> src/dev_tutorial_<YOUR_USERNAME>/messy_code.py:3:5
122+
--> src/dev_tutorial_<YOUR_USERNAME>/messy.py:3:5
123123
|
124124
1 | def calculate_statistics(data, include_median=True):
125125
2 | """Calculate statistics for a list of numbers."""

‎docs/tests.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Here's a simple example testing the `add` function from `tests/test_functions.py
9292

9393
```python
9494
# tests/test_functions.py
95-
from dev_tutorial.functions import add
95+
from dev_tutorial_<YOUR_USERNAME>.functions import add
9696

9797
def test_add():
9898
"""Test the `add` function."""
@@ -126,7 +126,7 @@ def list_of_integers():
126126

127127
```python
128128
# tests/test_functions.py
129-
from dev_tutorial.functions import sum_and_multiply
129+
from dev_tutorial_<YOUR_USERNAME>.functions import sum_and_multiply
130130

131131
def test_fixture(list_of_integers):
132132
"""Test the `sum_and_multiply` function using the `list_of_integers` fixture."""

0 commit comments

Comments
 (0)