mirror of
https://github.com/arcan1s/ahriman.git
synced 2026-10-31 13:33:06 +00:00
docs: take note on parametrized tests
This commit is contained in:
1 parent
5ad8a2a7d0
commit
64a7e9b288
1 file changed
+1
@@ -222,6 +222,7 @@ Again, the most checks can be performed by `tox` command, though some additional
|
||||
* On the other hand, it is allowed to change method signatures, however, it is recommended to add new parameters as optional if possible. Deprecated API can be dropped during major release.
|
||||
* Enumerations (`Enum` classes) are allowed and recommended. However, it is recommended to use `StrEnum` class if there are from/to string conversions and `IntEnum` otherwise.
|
||||
* `Generator` return type is not allowed. Generator functions must return generic `Iterator` object. Documentation should be described as `Yields`, however, because of pylint checks. Unfortunately, `Iterable` return type is not available for generators also, because of specific `contextlib.contextmanager` case.
|
||||
* Tests must not be parametrized. It is better to write separate test, which covers specific line of code rather than testing all over again.
|
||||
|
||||
### Other checks
|
||||
|
||||
|
||||
Reference in new issue
Block a user