TST/DOC: add tests and use new docstring style for class OnyoRepo
#394
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #394 +/- ##
==========================================
+ Coverage 94.58% 94.79% +0.21%
==========================================
Files 51 51
Lines 3990 4037 +47
Branches 947 953 +6
==========================================
+ Hits 3774 3827 +53
+ Misses 121 117 -4
+ Partials 95 93 -2
☔ View full report in Codecov by Sentry. |
OnyoRepoOnyoRepo
Gives the function a new docstring in the style discussed in issue psyinfra#339. Also normalizes type hints e.g. usage of `Optional`, and other code style aspects.
Adds a docstring in the style discussed in psyinfra#339. This test modifies an asset in OnyoRepo with an external function so that the cache is not up-to-date, and then tests the function `OnyoRepo.clear_caches()` to re-load the cache.
OnyoRepoOnyoRepo
bpoldrack
reviewed
Jul 28, 2023
Gives the function a new docstring in the style discussed in issue psyinfra#339. The test modifies an OnyoRepo with the python implementations of the commands and then calls `generate_commit_message()` and checks the default commit message that was generated. There is the idea to change the commit message body in a future PR. This would impact parts of the test function written now, and I assume the current test should help as a starting point to test the new format.
I add a doc-string to the function and test for the specified definition of it.
A collection of small changes, that does not effect the code, and that did not fit into the other commits. Applies for some functions the new docstring style. Some changes are also just about writting style, that I figured out too late to include in the other commits before.
I update the doc-string of the function to the new style, and change the type hints, because this function should just recive a string. Adds also tests to the function for valid and invalid calls.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
OnyoRepo