Skip to content

Commit 29b24aa

Browse files
committed
Replace comment notes
1 parent ac2c4b7 commit 29b24aa

4 files changed

Lines changed: 10 additions & 7 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Directories
2-
SRC_PATHS := project_name/ test/ # FIXME
2+
SRC_PATHS := project_name/ test/ # TODO
33

44
# Targets
55
.PHONY: help

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[//]: # (FIXME)
1+
[//]: # (TODO)
22

33
# 🐍 Python Project Template 🚀
44

5-
[//]: # (FIXME)
5+
[//]: # (TODO)
66
![example workflow](https://github.com/ankandrew/python-project-template/actions/workflows/main.yaml/badge.svg)
77

88
A modern Python project template to kickstart your next Python project with all the necessary tools and configurations.
@@ -26,7 +26,7 @@ A modern Python project template to kickstart your next Python project with all
2626
```bash
2727
pipx install poetry
2828

29-
3. Replace `FIXME` comments in files with project/repo specific.
29+
3. Replace `TODO` comments in files with project/repo specific.
3030

3131
### TODO
3232

pyproject.toml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
2-
name = "project-name" # FIXME
2+
name = "project-name" # TODO
33
version = "0.1.0"
4-
description = "A short description of your package." # FIXME
4+
description = "A short description of your package." # TODO
55
authors = ["ankandrew <61120139+ankandrew@users.noreply.github.com>"]
66
readme = "README.md"
77

@@ -58,6 +58,9 @@ max-line-length = 100
5858
[tool.pylint.basic]
5959
no-docstring-rgx = "^__|^test_"
6060

61+
[tool.pylint.miscellaneous]
62+
notes = ["FIXME", "XXX"]
63+
6164
[build-system]
6265
requires = ["poetry-core"]
6366
build-backend = "poetry.core.masonry.api"

test/project_name/test_src.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
"""
44

55

6-
# FIXME
6+
# TODO
77
def test_src() -> None:
88
"""Dummy test"""

0 commit comments

Comments
 (0)