Skip to content
This repository was archived by the owner on Jan 10, 2023. It is now read-only.
This repository was archived by the owner on Jan 10, 2023. It is now read-only.

Clean up documentation #238

Description

@vicng

Here's what's needed for documentation cleanup:

  1. Categorize sections better. Replace "// MARK: - Public" (and "Open") with something more descriptive, as these marks are what show up in the generated jazzy docs.
  2. Remove use of self. in comments -- jazzy doesn't link properly when these are encountered.
  3. When referencing member of other classes, use the format ClassName.memberName in order for jazzy linking to work properly.
  4. [Nit] Make sure each sentence ends with a period.
  5. Fix - Throws so that each error type documented is in a sub-bulleted list.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions