-
Notifications
You must be signed in to change notification settings - Fork 29
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
Some clarifications, better docstrings, method for parsevalsum(fh, ::OneDGrid)
+ tests
#344
Conversation
parsevalsum(fh, ::OneDGrid)
+ tests
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.
Just a few formatting things with the code blocks. Sorry if these are deliberate and look good in the docs but when I copy and pasted them into comment box the code block stops and starts and looked a little odd.
thanks @jbisits, have a look now? |
where ``û_{𝐤} =`` `uh` ``/(`` `grid.nx` ``e^{- i 𝐤 ⋅ 𝐱₀})``, with ``𝐱₀`` the vector with components | ||
the left-most position in each direction. | ||
where ``û_{𝐤} =`` `uh` `` / (n_x e^{i 𝐤 ⋅ 𝐱₀})``, with ``𝐱₀`` the vector with components | ||
the left-most position in each direction, e.g., for a 2D grid `(grid.x[1], grid.y[1])`. |
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 think the second half of this sentence (applies to all instances of this) could still be a little clearer. Maybe instead could be along the lines of
where
û_{𝐤} =
uh
/ (n_x e^{i 𝐤 ⋅ 𝐱₀})
and𝐱₀
is the vector with components in
the left-most position in each direction, ...
or
where
û_{𝐤} =
uh
/ (n_x e^{i 𝐤 ⋅ 𝐱₀})
. The elements of the vector𝐱₀
are the left-most position in each direction, ...
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.
Damn I merged before noticing this.
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.
No worries! I can do this or just add it to a list and do it in a future PR? It is not completely necessary, only if you think the change makes it clearer.
Looks good! |
No description provided.