chore: Updates docstring #533
Conversation
Since type hint already added to args
unnecessary anymore since type hint works for auto completion
Except for property and TypeVar
| Returns: | ||
| bool: `True` if the service was running before being stopped | ||
| `True` if the service was running before being stopped |
There was a problem hiding this comment.
Need bool or not?
(L198 has bool, but here has no it)
There was a problem hiding this comment.
Unnecessary for here since stop() → bool already has return type in below doc.
Return type: bool will be removed from doc, but it's no problem from user point of view, I think.
| Returns: | ||
| bool: `True` if app is installed | ||
| `True` if app is installed |
| Returns: | ||
| bool: `True` if the service was running before being stopped | ||
| `True` if the service was running before being stopped |
There was a problem hiding this comment.
Unnecessary for here since stop() → bool already has return type in below doc.
Return type: bool will be removed from doc, but it's no problem from user point of view, I think.
| Returns: | ||
| bool: `True` or `False` | ||
| bool: `True` if the service is running |
There was a problem hiding this comment.
Necessary here since property's one doesn't have bool in below doc.
(I'd like to change here to True if the service is running, cannot do so. I know it's not good way 🤔 .)
Currently
property is_running
Ideally like this
property is_running -> bool
2 participants
For #529
Changes