Skip to content

[Docs] Document the Converter type and all the cases it needs to support #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 7, 2023

Conversation

czechboy0
Copy link
Contributor

Motivation

I wrote down how the Converter works and all the cases we need to support. That'll help prepare ground for the refactor needed for #43.

Also created space for maintainer-focused docs.

Modifications

Added docs, which I'll use in a subsequent PR to ensure all the cases listed are implemented and tested.

Result

Converter now has higher level docs, and maintainers have a place to add more docs.

Test Plan

Previewed locally.

@czechboy0 czechboy0 requested a review from simonjbeaumont June 6, 2023 15:22
@czechboy0 czechboy0 changed the title [Docs] Document the Converter type in preparation for #43 [Docs] Document the Converter type and all the cases it needs to support Jun 6, 2023
Copy link
Collaborator

@simonjbeaumont simonjbeaumont left a comment

Choose a reason for hiding this comment

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

Thanks for starting this document @czechboy0, it's great to get some of these maintainer-focused docs going.

I had some questions about whether we need to have the combinatorial explosion of methods that all need to be individually targeted by the generated code or whether we could manage to have something more general-purpose, which might farm out to other private things. If it doesn't have too much of an overhead, it might simplify the generated code and the generator a bit?

@czechboy0 czechboy0 requested a review from simonjbeaumont June 6, 2023 16:16
@czechboy0 czechboy0 requested a review from simonjbeaumont June 7, 2023 11:27
@czechboy0 czechboy0 merged commit 7186fd5 into apple:main Jun 7, 2023
@czechboy0 czechboy0 deleted the hd-docs-converter branch June 7, 2023 11:54
@czechboy0 czechboy0 added the 🔨 semver/patch No public API change. label Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants