From f79f5589f60486dc5494502d5c98f24ab8f3dc3a Mon Sep 17 00:00:00 2001 From: Arne Wischer Date: Fri, 6 Dec 2019 16:01:39 +0100 Subject: [PATCH] Added more docstring --- .vscode/settings.json | 3 ++- days/comp.py | 14 +++++++++++++- days/day2.py | 2 +- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index b07a863..2222bad 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,6 @@ { "python.linting.pylintEnabled": false, "python.linting.pycodestyleEnabled": true, - "python.linting.enabled": true + "python.linting.enabled": true, + "autoDocstring.docstringFormat": "google" } \ No newline at end of file diff --git a/days/comp.py b/days/comp.py index 34fff41..a3f171e 100644 --- a/days/comp.py +++ b/days/comp.py @@ -1,7 +1,19 @@ -from typing import * +from typing import List, Tuple class OpcodeComputer(): + """OpcodeCOmputer for Advent of Code 2019 + + OpcodeComputer as specified by day 2 and 5 of the Advent of \ + Code 2019 challenge. + + .. _Advent of Code 2019 day 2 + https://adventofcode.com/2019/day/2 + + .. _Advent of Code 2019 day 5 + https://adventofcode.com/2019/day/5 + + """ def parse_param(self, pc: int, mem: List[int]) \ -> Tuple[int, int, int, int]: diff --git a/days/day2.py b/days/day2.py index 8e08ab9..ccb5e51 100644 --- a/days/day2.py +++ b/days/day2.py @@ -1,6 +1,6 @@ import unittest import os -from typing import * +from typing import List from .comp import OpcodeComputer