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

Write documentation for relevant protocol methods #3813

Closed
austinzheng opened this issue Jun 30, 2016 · 2 comments
Closed

Write documentation for relevant protocol methods #3813

austinzheng opened this issue Jun 30, 2016 · 2 comments

Comments

@austinzheng
Copy link
Contributor

austinzheng commented Jun 30, 2016

Protocol members like count, isEmpty, etc that would reasonably be of interest to a user should be documented explicitly. This is so they show up directly in our Jazzy docs.

@austinzheng
Copy link
Contributor Author

Context:

I think we have to look at it from the users perspective. When I go to the doc with the intention to find out how I get the length of the List, I don’t want to have to explore a labyrinth of protocols, I just want to know what to call. (Alexander Stigsen)

There are a couple of members (like count) that are defined in a superclass marked as :nodoc:, which means that Jazzy won't generate documentation for them. I will probably end up moving those methods into the public API subclass so that we can generate documentation for them. (@jpsim)

@jpsim
Copy link
Contributor

jpsim commented Jul 20, 2016

Relevant jazzy issue: realm/jazzy#190

@sync-by-unito sync-by-unito bot closed this as completed Sep 12, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 14, 2024
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

4 participants