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

Clean up documentation #238

Open
vicng opened this issue Oct 13, 2016 · 0 comments
Open

Clean up documentation #238

vicng opened this issue Oct 13, 2016 · 0 comments
Milestone

Comments

@vicng
Copy link
Contributor

vicng commented Oct 13, 2016

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.
@CoryDCode CoryDCode added this to the V1 milestone Dec 1, 2016
@vicng vicng changed the title Better categorization of documentation Clean up documentation May 24, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants