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

Some clarifications, better docstrings, method for parsevalsum(fh, ::OneDGrid) + tests #344

Merged
merged 10 commits into from
Dec 31, 2022

Conversation

navidcy
Copy link
Member

@navidcy navidcy commented Dec 29, 2022

No description provided.

@navidcy navidcy changed the title clarifications + plot analytic derivative Some clarifications, better docstrings, method for parsevalsum(fh, ::OneDGrid) + tests Dec 29, 2022
@navidcy navidcy marked this pull request as ready for review December 29, 2022 19:51
Copy link
Collaborator

@jbisits jbisits left a 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.

docs/src/grids.md Outdated Show resolved Hide resolved
docs/src/grids.md Outdated Show resolved Hide resolved
docs/src/grids.md Outdated Show resolved Hide resolved
src/utils.jl Outdated Show resolved Hide resolved
src/utils.jl Outdated Show resolved Hide resolved
src/utils.jl Outdated Show resolved Hide resolved
@navidcy
Copy link
Member Author

navidcy commented Dec 31, 2022

thanks @jbisits, have a look now?

@navidcy navidcy requested a review from jbisits December 31, 2022 00:20
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])`.
Copy link
Collaborator

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, ...

Copy link
Member Author

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.

Copy link
Collaborator

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.

@jbisits
Copy link
Collaborator

jbisits commented Dec 31, 2022

thanks @jbisits, have a look now?

Looks good!

@navidcy navidcy merged commit 3a65852 into main Dec 31, 2022
@navidcy navidcy deleted the ncc/patches branch December 31, 2022 01:58
@navidcy navidcy restored the ncc/patches branch January 28, 2023 22:27
@navidcy navidcy deleted the ncc/patches branch February 11, 2023 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants