Skip to content
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] Replace tensor by field for files beginning with t to z #1579

Merged
merged 2 commits into from
Jul 25, 2020

Conversation

Rullec
Copy link
Contributor

@Rullec Rullec commented Jul 24, 2020

Related issue = #1500

This PR tries to replace tensor by feld for files beginning with t to z

  • taichicon.rst
  • tensor_matrix.rst
  • type.rst
  • utilities.rst
  • vector.rst
  • versioning_releases.rst

[Click here for the format server]


@Rullec Rullec changed the title Replace tensor part 3 [Doc] Replace tensor by field for files beginning with t to z Jul 24, 2020
@Rullec Rullec changed the title [Doc] Replace tensor by field for files beginning with t to z [Doc] Replace tensor by field for files beginning with t to z Jul 24, 2020
@Rullec
Copy link
Contributor Author

Rullec commented Jul 24, 2020

Hi @archibate !

So I have mostly updated all tensors to fields in our documents.

And the changes are broken into 3 seperate PRs: 1577, 1578, 1579. Would you please give me some suggestions?

Copy link
Collaborator

@archibate archibate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've a name nit.

Comment on lines +3 to +4
Fields and matrices
===================
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Fields and matrices
===================
Matrix fields
=============

The same to Vector fields, it should sounds more than intuitive for STEM students, WDYT? @yuanming-hu @Rullec

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good idea. But I guess the main task of this PR is simply do replacement, and make sure the replacements have no error.
I would personally prefer to refine the whole documents, make them more fluent and accurate in another PR, HDYT?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, thank for the reminder, let's do matrix fields iapr.

Comment on lines +14 to +15
Fields of scalars
-----------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Fields of scalars
-----------------
Scalar fields
-------------


- Global ``scalars`` are treated as 0-D tensors of scalars.
- Global ``scalars`` are treated as 0-D fields of scalars.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Global ``scalars`` are treated as 0-D fields of scalars.
- Global ``scalars`` are treated as 0-D scalar fields.

Please update the following changes too, I don't have time to comment them one-by-one.

@codecov
Copy link

codecov bot commented Jul 24, 2020

Codecov Report

Merging #1579 into rullec-field will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@              Coverage Diff              @@
##           rullec-field    #1579   +/-   ##
=============================================
  Coverage         67.45%   67.45%           
=============================================
  Files                40       40           
  Lines              5626     5626           
  Branches            981      981           
=============================================
  Hits               3795     3795           
  Misses             1662     1662           
  Partials            169      169           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 505cfcf...be09d90. Read the comment docs.

Copy link
Collaborator

@archibate archibate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. (don't forget to matrix field iapr :)

@archibate archibate merged commit 728fd3b into taichi-dev:rullec-field Jul 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants