Merge pull request #34 from musslick/musslick-patch-2

Musslick patch 2

Author: musslick

…thub/workflows/docs-publish.yml.disabled .github/workflows/docs-publish.yml.github/workflows/docs-publish.yml.disabled renamed to .github/workflows/docs-publish.yml .github/workflows/docs-publish.yml.disabled renamed to .github/workflows/docs-publish.yml

@@ -37,4 +37,4 @@ jobs:
       with:
         repository_url: https://test.pypi.org/legacy/
         user: __token__
-        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}

…ub/workflows/python-publish.yml.disabled .github/workflows/python-publish.yml.github/workflows/python-publish.yml.disabled renamed to .github/workflows/python-publish.yml .github/workflows/python-publish.yml.disabled renamed to .github/workflows/python-publish.yml

@@ -1,4 +1,4 @@
-# Basic Tutorial for Open Source Development on GitHub
+# Hello
 
 ## Requirements
 

…ithub/workflows/test-pytest.yml.disabled .github/workflows/test-pytest.yml.github/workflows/test-pytest.yml.disabled renamed to .github/workflows/test-pytest.yml .github/workflows/test-pytest.yml.disabled renamed to .github/workflows/test-pytest.yml

@@ -26,9 +26,9 @@ extra_javascript: [
 ]
 
 site_name: Contributor Onboarding
-repo_url: 'https://github.com/GITHUBUSERNAME/contributor-onboarding'
+repo_url: 'https://github.com/musslick/contributor-onboarding'
 
 nav:
 - Home: 'index.md'
 - Resources:
-      - 'resources/github-basics.md'
+      - 'resources/github-basics.md'

docs/index.md

@@ -24,8 +24,8 @@ test = [
 ]
 
 [project.urls]
-repository = "https://github.com/GITHUBUSERNAME/contributor-onboarding"
-documentation = "https://GITHUBUSERNAME.github.io/contributor-onboarding/"
+repository = "https://github.com/musslick/contributor-onboarding"
+documentation = "https://musslick.github.io/contributor-onboarding/"
 
 [build-system]
 requires = ["setuptools", "setuptools_scm"]

mkdocs.yml

@@ -55,10 +55,7 @@ def modulo(a: int, b: int):
     float
     '''
 
-    # I think this could be made more efficient?
-    result = a - (np.floor(a / b) * b)
-
-    return result
+    return a%b
 
 def element_wise_multiply(a: np.array, b: np.array) -> np.array:
     '''
@@ -76,7 +73,8 @@ def element_wise_multiply(a: np.array, b: np.array) -> np.array:
 
     return np.multiply(a, b)
 
-def return_hexadecimal(a: int) -> float:
+# change output type of return_hexadecimal function
+def return_hexadecimal(a: int) -> str:
     '''
     ...
 
@@ -103,4 +101,4 @@ def return_random_number() -> int:
     float
     '''
 
-    return np.random.randint(0, 100)
+    return np.random.randint(0, 100)

pyproject.toml

@@ -0,0 +1,11 @@
+from src.utils import modulo
+def test_modulo():
+    a = 3
+    b = 2
+
+    c = 0
+
+    assert modulo(a, b) == 1
+    assert modulo(b, a) == 2
+    assert modulo(b, b) == 0
+    assert modulo(c, b) == 0

src/utils.py

@@ -0,0 +1,9 @@
+from src.utils import sum
+
+def test_sum():
+    a = 3
+    b = 4
+
+    
+
+    assert sum(a,b) == 7