Merge remote-tracking branch 'refs/remotes/origin/main'

Author: rambasnet

.gitignore

@@ -38,7 +38,6 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-htmlcov/
 .tox/
 .nox/
 .coverage
@@ -127,4 +126,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 .DS_Store
-htmlcov/
+htmlcov/

Makefile

@@ -36,11 +36,11 @@ run-test:
 
 .PHONY: run-test-coverage
 run-test-coverage:
-	$(COVERAGE) -v --cov-report=html:$(DEMO)/A0/hello/htmlcov --cov-report=term --cov=$(DEMO)/A0/hello $(DEMO)/A0/hello/tests
-	$(COVERAGE) -v --cov-report=html:$(DEMO)/A0-OOP/hello/htmlcov --cov-report=term --cov=$(DEMO)/A0-OOP/hello $(DEMO)/A0-OOP/hello/tests
-	$(COVERAGE) -v --cov-report=html:$(DEMO)/A1/cold/htmlcov --cov-report=term --cov=$(DEMO)/A1/cold $(DEMO)/A1/cold/tests
-	$(COVERAGE) -v --cov-report=html:$(DEMO)/A1-OOP/cold/htmlcov --cov-report=term --cov=$(DEMO)/A1-OOP/cold $(DEMO)/A1-OOP/cold/tests
-	$(COVERAGE) -v --cov-report=html:$(DEMO)/A2-ABC/egypt/htmlcov --cov-report=term --cov=$(DEMO)/A2-ABC/egypt $(DEMO)/A2-ABC/egypt/tests
+	$(COVERAGE) -v --cov-report=term-missing --cov=$(DEMO)/A0/hello $(DEMO)/A0/hello/tests
+	$(COVERAGE) -v --cov-report=term-missing --cov=$(DEMO)/A0-OOP/hello $(DEMO)/A0-OOP/hello/tests
+	$(COVERAGE) -v --cov-report=term-missing --cov=$(DEMO)/A1/cold $(DEMO)/A1/cold/tests
+	$(COVERAGE) -v --cov-report=term-missing --cov=$(DEMO)/A1-OOP/cold $(DEMO)/A1-OOP/cold/tests
+	$(COVERAGE) -v --cov-report=term-missing --cov=$(DEMO)/A2-ABC/egypt $(DEMO)/A2-ABC/egypt/tests
 
 .PHONY: clean
 clean:

demo-assignments/A0-OOP/hello/Makefile

@@ -29,7 +29,6 @@ run-test-coverage: create-doc-folder
 	pytest --verbose --color=yes --cov --cov-report term-missing --cov-report=html:$(DOCS)/test-cov tests/
 	@echo "All unittests passed!"
 
-
 .PHONY: check-types
 check-types:
 # use shell command which to check if mypy is installed and is in $PATH
@@ -46,6 +45,7 @@ create-doc-folder:
 
 .PHONY: create-docs
 create-docs: create-doc-folder
+	# provide each module name; current path . not working!
 	pdoc --output-dir $(DOCS)/code-docs hello.py main.py # creates html docs
 	@echo "html docs created and saved in $(DOCS)/code-docs"
 

demo-assignments/A0-OOP/hello/docs/code-docs/hello.md

@@ -0,0 +1,30 @@
+Module hello
+============
+Hello World Program using OOP
+
+Classes
+-------
+
+`HelloWorld()`
+:   Hello World Class
+    
+    Constructor
+
+    ### Instance variables
+
+    `message: str`
+    :   Returns the message - using getter property
+        
+        Returns:
+                self._message (str): Message stored in the object
+
+    ### Methods
+
+    `get_message(self) ‑> str`
+    :   Returns the message - using getter method
+        
+        Returns:
+                self._message (str): Message stored in the object
+
+    `print_message(self) ‑> None`
+    :   Prints the message