Re-organise some coord docs #6954
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dstansby
added
the
No Backport
Cadair
reviewed
Apr 26, 2023
|
Is this intended to address #6864 as well? |
Nope |
Co-authored-by: Stuart Mumford <stuart@cadair.com>
Cadair
requested changes
May 3, 2023
wtbarnes
reviewed
May 4, 2023
wtbarnes
reviewed
May 4, 2023
|
I'm unlikely to get back to this in the next week, so if anyone wants to push to my branch feel free |
wtbarnes
requested changes
May 4, 2023
There was a problem hiding this comment.
Thanks for taking this on @dstansby. To summarize my requests from my inline comments:
- Move "getting started" section to a "how-to" guide on how to create coordinate objects
- Move "transforming between coordinate frames" to a how-to guide
- Move text on the 2D-3D transformation to a topic guide
at this point, I think we could directly copy the text here to those new sections and we can wordsmith/refine in subsequent PRs.
|
Ok I've addressed the points I highlighted above. I think the RSUN topic guide needs more detail, but I think we can leave that to another PR. |
Cadair
approved these changes
May 9, 2023
wtbarnes
approved these changes
May 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #6913.
A lot of the tutorial content was duplicated. In the guide page, there was also some accessing coordinate components content that felt like a how to guide, so I moved that there. I'm open to a bit of bikeshedding in this PR, but would be good to get this in realtively quickly in time for 5.0.