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

[auth-swift] Modernize Auth API docs #12353

Merged
merged 10 commits into from
Feb 7, 2024
Merged

[auth-swift] Modernize Auth API docs #12353

merged 10 commits into from
Feb 7, 2024

Conversation

paulb777
Copy link
Member

@paulb777 paulb777 commented Feb 5, 2024

Update Auth API docs implementation format so it generates correctly in Xcode documentation builds

  • The PR primarily does the mechanical update and does not address missing documentation.
  • It does fix obvious typos and a few obvious mistakes
  • It only addresses the library and does not modernize test documentation
  • Add back some docs that got missed in the Swift transition
  • Split many API docs between summary and discussion with an extra blank line in the source

In general public API docs are mostly complete, while internal and private API documentation is hit or miss.

Note that the new doc format is more compact. Over 2000 lines deleted with no loss of info.

@google-oss-bot
Copy link

1 Warning
⚠️ Did you forget to add a changelog entry? (Add #no-changelog to the PR description to silence this warning.)

Generated by 🚫 Danger

Copy link
Contributor

@renkelvin renkelvin left a comment

Choose a reason for hiding this comment

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

Thanks Paul!

Out of curiosity, are these changes made by the style.sh script?

@paulb777
Copy link
Member Author

paulb777 commented Feb 7, 2024

@renkelvin The style script only fixes indentation and line lengths. Most of these changes were from ad-hoc editor scripts and manual review.

@paulb777
Copy link
Member Author

paulb777 commented Feb 7, 2024

Going to merge here. Let's address any follow up in subsequent PRs.

@paulb777 paulb777 merged commit c959f1b into auth-swift Feb 7, 2024
48 checks passed
@paulb777 paulb777 deleted the pb-auth-docs branch February 7, 2024 16:25
@firebase firebase locked and limited conversation to collaborators Mar 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants