Document framework naming - #855
Merged
Merged
Conversation
joshka
marked this pull request as ready for review
August 5, 2026 03:10
madsmtm
approved these changes
Aug 5, 2026
|
|
||
| ## Naming | ||
|
|
||
| The framework crates generally retain Objective-C selector names, rather than |
Owner
There was a problem hiding this comment.
Nit: retain is a bit overloaded in Objective-C context.
Suggested change
| The framework crates generally retain Objective-C selector names, rather than | |
| The framework crates generally use Objective-C selector names, rather than |
Comment on lines
+25
to
+26
| When comparing an API with Apple documentation, select the Objective-C | ||
| language view, for example [NSApplication.sharedApplication][nsapplication-shared-application]. |
Owner
There was a problem hiding this comment.
I'd prefer something like this? Reads a bit clearer to me, and also provides guidance on where the place to change the language is (I think you have to click the button, Apple's docs sometimes cache the chosen language and redirects IIUC).
Suggested change
| When comparing an API with Apple documentation, select the Objective-C | |
| language view, for example [NSApplication.sharedApplication][nsapplication-shared-application]. | |
| When comparing APIs with Apple's documentation, select the Objective-C | |
| language view in the top right, for example [NSApplication.sharedApplication][nsapplication-shared-application]. |
joshka
force-pushed
the
joshka/document-framework-naming
branch
from
August 6, 2026 00:56
9697af9 to
f6c8cc7
Compare
Contributor
Author
|
I addressed both comments in f6c8cc7 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I got briefly confused by Apple’s default Swift documentation showing
NSApplication.shared, while objc2 exposesNSApplication::sharedApplication.I’m new both to objc2 and to macOS app development, so I didn’t have the context to make that connection. The existing naming-policy discussion explains why, but I only found it after asking an LLM to help me understand this. This adds a short note to the generated-framework overview explaining the Objective-C/Swift naming difference and linking to both the Objective-C Apple docs and the policy discussion.