Improve documentation grammar and usage. #1088
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
"To look up (a thing)" is a phrasal verb, whereas the single word "lookup" (written without spaces) is generally used as a noun (for example: "in order to avoid an expensive lookup") and occasionally as an adjective (for example: "a lookup table"). Some parts of the documentation already use "look up" in a verbal context. For example, `Data.Map.Internal.hs:1295` models correct usage: ```hs -- Look up a key and return a result indicating whether it was found -- and what path was taken. lookupTrace :: Ord k => k -> Map k a -> TraceResult a ``` This commit adjusts the rest of the documentation (and comments) to match this usage (when "look up" is used as a verb). When "lookup" is used as a noun or an adjective, we leave it alone. This usage of phrasal verbs is similar to: - "pick up" (verb) vs "pickup" (noun) - "sit up" (verb) vs "situp" (noun) - "log in" (verb) vs "login" (noun) - "start up" (verb) vs "startup" (noun) - "set up" (verb) vs "setup" (noun)
This commit also replaces "the" with "this" for consistency with documentation for other functions.
meooow25
approved these changes
Jan 6, 2025
|
Thanks! |
@meooow25 You're welcome! |
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 PR makes a few small grammar fixes within documentation and comments.
In particular, it: