Improve iOS documentation #3873
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
madsmtm
commented
Aug 15, 2024
madsmtm
force-pushed
the
madsmtm/remove-window-activation-hacks
branch
from
7592010
to
82344b2
Compare
daxpedda
approved these changes
Aug 16, 2024
madsmtm
force-pushed
the
madsmtm/ios-docs
branch
from
c77b1e0
to
5ae95ca
Compare
Base automatically changed from
madsmtm/remove-window-activation-hacks
to
master
August 18, 2024 21:50
madsmtm
force-pushed
the
madsmtm/ios-docs
branch
from
5ae95ca
to
4d07130
Compare
daxpedda
approved these changes
Aug 18, 2024
There was a problem hiding this comment.
What a treasure trove of information!
While most of the backends don't need this much documentation, lets hope we can raise the standard of all the documentation in Winit to this level one day.
EDIT: I was briefly thinking that this is a bit too much for Winit. But considering how much special handling the iOS backend needs, I think a general overview of how to even run it is appropriate.
We might want to consider linking to it from the README in the future when we get the examples working for Android as well.
Agreed, I'd much prefer to link to an external resource, but I don't think such a resource exists (yet), so in Winit it is for now. |
The old instructions are outdated, and suggested a workaround that is unnecessary. The user-story in the ecosystem is sadly not very clear-cut, so the instructions here are still woefully incomplete.
These platform-specific notes on `Window` methods were unnecessary, as it's already discussed in the top-level `Window` docs.
madsmtm
force-pushed
the
madsmtm/ios-docs
branch
from
4d07130
to
9952540
Compare
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.
Improve the platform-specific documentation with:
Builds upon #3872 to avoid a rebase later on.