You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.
Categorize sections better. Replace "// MARK: - Public" (and "Open") with something more descriptive, as these marks are what show up in the generated jazzy docs.
Remove use of self. in comments -- jazzy doesn't link properly when these are encountered.
When referencing member of other classes, use the format ClassName.memberName in order for jazzy linking to work properly.
[Nit] Make sure each sentence ends with a period.
Fix - Throws so that each error type documented is in a sub-bulleted list.
The text was updated successfully, but these errors were encountered:
Here's what's needed for documentation cleanup:
self.
in comments -- jazzy doesn't link properly when these are encountered.ClassName.memberName
in order for jazzy linking to work properly.- Throws
so that each error type documented is in a sub-bulleted list.The text was updated successfully, but these errors were encountered: