-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
[Doc] Add Python docstring for SNode #2580
Conversation
/format |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a few comments but in general looks good!
One minor question: is the reason we don't use type annotations in python/taichi/lang/snode.py
that it requires extra import List, ... from typing
, or that it simply hasn't happened yet?
It's a combination of me being lazy and the code hierarchy: I was planning to use the |
Ah, gotcha. I'm fine with leaving them as is then! (we could use forward references to bypass the circular import, but I guess we can solve it once and for all by refactoring the code later?) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
+1, I feel like the code needs some refactor before we have all the types we need for annotation |
Related issue = #2579
In addition to the docstring itself, this PR serves as an example for how to do class/method referencing.