-
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] Minor updates in hello.rst
#963
Conversation
@TH3CHARLie thanks for the tips. Although the code samples in |
LGTM! The new code samples added in |
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.
Thank for refactoring the doc, LGTM except for a few nits.
@@ -129,8 +129,8 @@ You can also define Taichi **functions** with ``ti.func``, which can be called a | |||
|
|||
.. note:: | |||
|
|||
**Taichi-scope v.s. Python-scope**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scope, which will be compiled by the Taichi compiler. | |||
Code outside the Taichi-scopes is simply normal Python code. | |||
**Taichi-scopes v.s. Python-scopes**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scope, which will be compiled by the Taichi compiler. |
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.
If you want everything to be scopes
, then why not:
**Taichi-scopes v.s. Python-scopes**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scope, which will be compiled by the Taichi compiler. | |
**Taichi-scopes v.s. Python-scopes**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scopes, which will be compiled by the Taichi compiler. |
You may want to run find docs -exec grep -Hw scope {} \;
to find out more.
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.
Let's unify the usage of scope
in a separate PR to make this one easier to review :-)
**Taichi-scope v.s. Python-scope**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scope, which will be compiled by the Taichi compiler. | ||
Code outside the Taichi-scopes is simply normal Python code. | ||
**Taichi-scopes v.s. Python-scopes**: everything decorated with ``ti.kernel`` and ``ti.func`` is in Taichi-scope, which will be compiled by the Taichi compiler. | ||
Everything else is in Python-scopes. They are simply Python code. |
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 still feel this a bit unconfortable..
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.
It doesn't read good to me either, but at least it's grammatically correct. Let's tolerate these places for now (unless there is a solution that is clearly better). Hopefully, someone native in English can help us out in the future.
Merging this for v0.6.4. As promised I'll unify the terminologies later: #941 (comment) |
Related issue = #941
(Found these issues while translating the doc to Chinese)
[Click here for the format server]