[IR] Add inline docs to all statements #2276
Merged
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
xumingkuan
changed the title
k-ye
reviewed
Apr 21, 2021
taichi/ir/statements.h
Outdated
| @@ -147,6 +165,9 @@ class RandStmt : public Stmt { | |||
| TI_DEFINE_ACCEPT_AND_CLONE | |||
| }; | |||
|
|
|||
| /** | |||
| * A binary operation. TODO: remove the field is_bit_vectorized. | |||
There was a problem hiding this comment.
- Move TODO to its own line, 2) properly quote the variable
| @@ -174,6 +195,10 @@ class BinaryOpStmt : public Stmt { | |||
| TI_DEFINE_ACCEPT_AND_CLONE | |||
| }; | |||
|
|
|||
| /** | |||
| * A ternary operation. Currently "select" (the ternary conditional operator, | |||
There was a problem hiding this comment.
Pls unify the variable quoting style
There was a problem hiding this comment.
Oh this is not a variable :-)
taichi/ir/statements.h
Outdated
| @@ -225,6 +256,9 @@ class ExternalPtrStmt : public Stmt { | |||
| TI_DEFINE_ACCEPT_AND_CLONE | |||
| }; | |||
|
|
|||
| /** | |||
| * A global pointer. | |||
There was a problem hiding this comment.
A bit more explanation on this (on a new paragraph)? For example, this will not show up in the final lowered IR.
xumingkuan
commented
Apr 21, 2021
taichi/ir/statements.h
Outdated
| @@ -1041,11 +1191,15 @@ class ClearListStmt : public Stmt { | |||
| // Checks if the task represented by |stmt| contains a single ClearListStmt. | |||
| bool is_clear_list_task(const OffloadedStmt *stmt); | |||
|
|
|||
| /** | |||
| * TODO: document for InternalFuncStmt | |||
There was a problem hiding this comment.
So... what's an InternalFuncStmt?
There was a problem hiding this comment.
It seems to be used by ti.call_internal, which is to run some C++ tests in taichi/runtime/llvm/internal_functions.h.
Let's put a TODO saying that we'd like to remove this :)
Co-authored-by: Ye Kuang <k-ye@users.noreply.github.com>
|
@k-ye Thanks for the review! |
k-ye
approved these changes
Apr 21, 2021
Merged
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.
Related issue = #2193 #2192
This PR adds inline docs to all statements in statements.h.
[Click here for the format server]