-
-
Notifications
You must be signed in to change notification settings - Fork 50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add option to replace todo #8
Conversation
Thanks for putting quite some effort into this. However, I don't understand why you want to use def myMethod(self: MyClass, p1: Sequence[T]) -> Generator[int, float, str]:
"""
TODO(<user>)
:param self MyClass: TODO(<user>)
:param p1 Sequence[T]: TODO(<user>)
:rtype Generator[int, float, str]: TODO(<user>)
"""
pass I'm not seeing in why this would be useful. I can understand it if you want to add more context to what the For example, this would be logical in a scenario where the numpy doc for Python has two TODO items at the top but it's not super clear what it should be. NOTE: I am planning to build this soon, giving more context to TODO items. Then this output would be more logical: def call(self, *args: str, **kwargs: str) -> str:
"""
TODO(<summary>)
TODO(<description>)
Parameters
----------
self : any
TODO(<description>)
args : str
TODO(<description>)
kwargs : str
TODO(<description>)
Returns
-------
str:
TODO(<description>)
"""
pass but this is not what you've submitted, so please, explain why this would be useful. |
Well, my case is that I have script for listing TODOs that matches only my As for the adding context to TODOs, it doesn't seem like that much extra work, I could add it if you want. |
I will add the context feature for now by myself, however I don't think this is something DoGe needs. If you want to give your descriptions more context for certain users you work with then this is a content issue and up to the user to add. I'll close the issue for now. Thanks for submitting your idea. |
The TODO context support is released in v1.4.0. |
Prelude
Thank you for helping out DoGe!
By contributing to DoGe you agree to the following statements (Replace
[ ]
with[x]
with those you agree with):Why this PR?
This PR enables user to use configurable placeholder in generated documentation.
For ex. instead of using
TODO
as placeholder I could useTODO(<user>)
.