docs: batched wording edits #23298
Merged
docs: batched wording edits #23298
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
This was common and we typically just mean "summary."
Git history covers this better and automatically.
Mainly make titles/headings easier to read, by swapping code for words and not using headings as links.
Shorten the titles for derivative rules and manual parallelism, and go for canonical wording in the parallel programming intro (typically we "shard" data, and "partition" computation, as part of parallel programming).
jakevdp
reviewed
Aug 28, 2024
| @@ -34,11 +36,13 @@ Table of contents: | |||
| # 🤯 0.9092974662780762 🤯 | |||
| ``` | |||
|
|
|||
| Click [here](print_breakpoint) to learn more! | |||
| [Read more](print_breakpoint). | |||
There was a problem hiding this comment.
I'd consider using a sphinx {ref}`target-name` syntax for the cross-references in this file, rather than linking via the filenames. It would involve adding a target name at the top of each of the referenced files, similar to this jax-array-migration target: https://github.com/google/jax/blob/ef33cf5acee2668b3e847aa19c91a52f6c18328d/docs/jax_array_migration.md#L1-L3
A benefit of this approach is that it automatically generates a hyperlink using the text from the referenced heading.
There was a problem hiding this comment.
That's useful in general. In this case I want the anchor text to say "read more," similar to what it did before this change.
jakevdp
approved these changes
Aug 28, 2024
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.
This is a batch of individually minor edits that aim for easier/clearer reading and some decluttering of titles and headings (which hopefully also helps in indices and in our navigation panel).