Skip to content
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

Customer Center DocC updates #4564

Merged
merged 5 commits into from
Dec 10, 2024
Merged

Conversation

fire-at-will
Copy link
Contributor

@fire-at-will fire-at-will commented Dec 9, 2024

This PR is a follow-up to some comments from #4560 's review and updates some of the Customer Center's DocC documentation. It:

  • Includes a high-level overview of the feature in the DoC for the CustomerCenterView and CustomerCenterViewController class/structs, taken from the public docs here: https://www.revenuecat.com/docs/tools/customer-center#overview
  • Brands the "Customer Center" by changing all references to the feature to be upper cased.

@fire-at-will fire-at-will self-assigned this Dec 9, 2024
@fire-at-will fire-at-will changed the title DocC updates Customer Center DocC updates Dec 9, 2024
@fire-at-will fire-at-will requested review from a team and aboedo December 9, 2024 19:28
@fire-at-will fire-at-will marked this pull request as ready for review December 9, 2024 19:28
@fire-at-will fire-at-will requested a review from vegaro December 9, 2024 19:29
@@ -18,10 +18,10 @@ import Foundation
/// Presentation options to use with the [presentCustomerCenter](x-source-tag://presentCustomerCenter) View modifiers.
public enum CustomerCenterPresentationMode {

/// Customer center presented using SwiftUI's `.sheet`.
/// Customer Center presented using SwiftUI's `.sheet`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it should use double backticks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The double backticks are used to link to a specific symbol/function. I think we'd need to use the full reference to a specific .sheet function. Since there are multiple .sheet functions, I think it's best to keep it as is and not mention a specific implementation in the docs in case we change it in the future

@fire-at-will fire-at-will enabled auto-merge (squash) December 10, 2024 21:24
@fire-at-will fire-at-will merged commit 105b40b into main Dec 10, 2024
9 checks passed
@fire-at-will fire-at-will deleted the customercenter-docc-enhancements branch December 10, 2024 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants