Fix #45: update test docstring (#47)

dsa-ou · Aug 28, 2024 · f71eee0 · f71eee0
1 parent 8dfad0b
commit f71eee0
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,8 @@ This project does *not* adhere to [Semantic Versioning](https://semver.org).
 ## [Unreleased](https://github.com/dsa-ou/algoesup/compare/v0.3.1...HEAD)
 These changes are in the GitHub repository but not on [PyPI](https://pypi.org/project/algoesup).
 
-Nothing yet.
+### Added
+- add to docstring that `test` doesn't accept built-in functions
 
 ## [0.3.1](https://github.com/dsa-ou/algoesup/compare/v0.3.0...v0.3.1) - 2024-08-17
 ### Fixed

diff --git a/docs/library/index.html b/docs/library/index.html
@@ -1121,7 +1121,7 @@ <h3 id="algoesup.test.test" class="doc doc-heading">
           </td>
           <td>
             <div class="doc-md-description">
-              <p>The function to be tested.</p>
+              <p>The function to be tested. Can&rsquo;t be a built-in function.</p>
             </div>
           </td>
           <td>

diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/src/algoesup/test.py b/src/algoesup/test.py
@@ -7,7 +7,7 @@ def test(function: Callable, test_table: list) -> None:
     """Test the function with the test_table. Report failed tests.
 
     Args:
-        function (Callable): The function to be tested.
+        function (Callable): The function to be tested. Can't be a built-in function.
         test_table (list): The list of tests. Each element of test_table is a list or
             tuple with: a string (the test case name); one or more values (the inputs to the function);
             the expected output value.