Skip to content

Flesh out documentation#285

Open
kaascevich wants to merge 27 commits intomoreSwift:mainfrom
kaascevich:parameter-documentation
Open

Flesh out documentation#285
kaascevich wants to merge 27 commits intomoreSwift:mainfrom
kaascevich:parameter-documentation

Conversation

@kaascevich
Copy link
Contributor

Right now, I've focused on adding documentation for parameters and return types, and documenting completely undocumented types. I'll improve on these (as well as the existing docs) as I become more familiar with SCUI's internals.

@kaascevich kaascevich force-pushed the parameter-documentation branch from bf7aca1 to 2634179 Compare December 29, 2025 05:14
@kaascevich
Copy link
Contributor Author

I'll probably wait to finish this PR until after the layout-performance branch is merged.

@stackotter
Copy link
Collaborator

Regarding the high level overview of SwiftCrossUI's internals, some of that has changed now, but #278 should explain most of the changes. I'm happy to help update that article if #278 doesn't explain certain things well enough

@stackotter
Copy link
Collaborator

Nvm you’ve already done that!

@kaascevich kaascevich closed this Jan 6, 2026
@kaascevich kaascevich deleted the parameter-documentation branch January 6, 2026 18:37
@kaascevich kaascevich restored the parameter-documentation branch January 6, 2026 18:38
@kaascevich kaascevich reopened this Jan 6, 2026
@kaascevich kaascevich marked this pull request as ready for review February 11, 2026 16:29
Copy link
Collaborator

@stackotter stackotter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still working my way through these changes; I'm just submitting what I've got so far so I don't lose it.

Copy link
Collaborator

@stackotter stackotter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm again still working through this, and I'm again just submitting what I've got so far so that I don't lose my progress. I've viewed 100/137 changed files.

Copy link
Collaborator

@stackotter stackotter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work with this PR! I'm sure that it was a lot of work, but it'll benefit almost everyone using the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants