Joss checklist/ Docs updates - #105
Conversation
|
reminder to test the docs locally 1- clone the repo |
|
Is this PR a good place to incorporate miscellaneous docs changes that might be good to do in general? If so, I had wanted to suggest changing the definition of
The reference to cardinal directions is a bit unclear since the user might not know which X,Y,Z direction corresponds to which cardinal direction. I'd recommend changing the description to: A potential issue with this definition is that I believe y is the vertical direction when running in 2D? If so, we can clarify. If you approve, I can make this change directly. It might also be worth adding a docs section and corresponding image on coordinate systems showing x, y, z, streamwise, spanwise, vertical, and then the tracker angle conventions? |
|
I'm noticing some inconsistencies in input parameter names. In the rendered docs online, |
No description provided.