Skip to content

📕 Is this API doc for ParseLiveQuery-iOS-OSX referenced anywhere? #651

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

Closed
noobs2ninjas opened this issue Jul 25, 2019 · 5 comments
Closed

Comments

@noobs2ninjas
Copy link
Member

noobs2ninjas commented Jul 25, 2019

References:
I ran into this old Parse Live Query API Doc for iOS/OSX. Unless I'm just blind I can't seem to find a single place on the parse platform site. Seems a bit behind but I never even knew it was out there.
Proposed solution:
Let's see if we can get it linked somewhere. I'll definitely be updating the repos README to link it at least.

@TomWFox
Copy link
Contributor

TomWFox commented Jul 25, 2019

I think you’re right about it not being referenced, I wasn’t aware of it. As there is no guide for live query I don’t think it would make sense to reference the api doc on the website (unless we decide to add a guide). Adding a reference in the readme is a good idea, we could also add a section called live query (under queries) in the iOS docs that gives a brief explanation and links to the readme and the api doc.

@noobs2ninjas
Copy link
Member Author

I agree. ParseLiveQuery I found out yesterday has a lot of work that needs to get done. Basically none of the callback functions work. So, I'll just add this in with it. In terms of docs since I'm working on those anyway I might just drop a quick mention and link to the LiveQuery repository itself and as well as in the iOS API documentation.

On a side note. It would seem strange to me that this would exist for ParseLiveQuery but not for ParseUI. I'll do some snooping in the source to see if I can find it.

@noobs2ninjas
Copy link
Member Author

noobs2ninjas commented Jul 26, 2019

NM your request was about ParseUI docs not the API page. How are all the API docs done?

@TomWFox
Copy link
Contributor

TomWFox commented Jul 26, 2019

No, that is actually another issue #596 - the links from the iOS guide to the ParseUI API doc 404 - I think it's related to how the jazzy docs are generated - it's not doing the ParseUI subfolder - If you can work out how to fix that please send a PR to the iOS repo 😉

@noobs2ninjas
Copy link
Member Author

noobs2ninjas commented Jul 26, 2019

Ill take a look.

I'm actually trying to fix ParseLiveQuery right now. So I may just write the docs since I'm also working on rewriting all the Parse docs. Speaking of ParseLiveQuery. Could you read this issue and give me your opinion.

We can close this issue I think since I'll just be writing the doc and doing the readme edits.

@TomWFox TomWFox closed this as completed Jul 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants