Skip to content

Commit 81c7851

Browse files
Update broken links
1 parent efeb8f5 commit 81c7851

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

short_courses/data_science_best_practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ While it is not essential to follow every recommendation to the letter, thoughtf
1111
- [Language: Python](#language-python)
1212
- [Version Control: Git](#version-control-git)
1313
- [Project Structure](#project-structure)
14-
- [README: README.md](#readme:-readmemd)
14+
- [README: README.md](#readmes)
1515
- [Project Config: TOML](#project-config-toml)
1616
- [IDE: VSCode](#ide-vscode)
1717
- [Packaging and Dependency Management: Poetry](#packaging-and-dependency-management-poetry)
@@ -214,7 +214,7 @@ NOTE: files beginning `.` are hidden files and will not appear unless showing hi
214214
ls -A
215215
```
216216

217-
## README: README.md
217+
## READMEs
218218
A well-structured README file is essential for providing users with clear instructions about the project. It should give an overview of the project, installation steps, usage instructions, and contribution guidelines. README.md file should be written in markdown, and contain basic project information, installation instructions and links to associated publications.
219219

220220
```markdown
@@ -496,7 +496,7 @@ These tests can also be run in groups or individually from the Testing panel in
496496
### Writing Tests
497497
It can be easy to get bogged down in writing extensive tests to ensure your code is doing what you expect. We suggest writing a basic set of tests initially and from there, as and when you encounter bugs or unexpected behaviour in your code, fix the bug, write a test that confirms it is fixed and move on. Over time a comprehensive set of test will develop that ensure your functions and methods are doing precisely what is expected, and prior mistakes are not being repeated.
498498

499-
Some templates for [simple](files/test_simple.py) and more [advanced](files/test_advanced.py) test files have been included.
499+
Some templates for [simple](files/example_test_simple.py) and more [advanced](files/example_test_advanced.py) test files have been included.
500500

501501
## Data
502502
Data should not be included in the git repository. If data is publicly available, then information on where to find it can be included in the README.md, or a script to download the data can be include in `scripts/`.

0 commit comments

Comments
 (0)