Canonical docstring comments #1491

maratal · 2022-08-24T16:07:40Z

Review process suggestions:

Do it on per-commit basis of course.
You can start from hash 9c6bb92, before are just verbatim copies from the canonical repo.
You can ignore commits where message starts from Mark... since they are just helper commits for keeping track of what I've already processed. I'll remove these marks after completion of all further edits.

Resulting doc can be found here:
https://sdk.ably.com/builds/ably/ably-cocoa/pull/1491/jazzydoc

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 262663e.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit eace29f.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit a437698.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit f357c0e.

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 7c45391.

ikbalkaya

Almost there. Just commented on some unraised conversation and a minor recommendation

ikbalkaya

Given all concerns are raised, now looks good to me 👍

…n protocol)

…t will in some cases be provided in the future PRs)

…dec in the docs.

maratal added 30 commits August 19, 2022 16:57

Add canonical docstring for ARTStatsMessageCount#count

0c233fd

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsMessageCount#data

5362566

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsMessageTypes

5ae5559

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsMessageTypes#all

cd60862

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 262663e.

Add canonical docstring for ARTStatsMessageTypes#messages

39476e7

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 262663e.

Add canonical docstring for ARTStatsMessageTypes#presence

d344031

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 262663e.

Add canonical docstring for ARTStatsMessageTraffic

2a90d63

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsMessageTraffic#all

aea531f

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit eace29f.

Add canonical docstring for ARTStatsMessageTraffic#realtime

36d2e4b

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit eace29f.

Add canonical docstring for ARTStatsMessageTraffic#rest

15789c9

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit eace29f.

Add canonical docstring for ARTStatsMessageTraffic#webhook

d5d7e1c

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit eace29f.

Add canonical docstring for ARTStatsRequestCount

78e71cc

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsRequestCount#succeeded

db309bf

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsRequestCount#failed

7e25696

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsRequestCount#refused

7a24761

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount

0e14b22

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount#opened

6553f45

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount#peak

352dc27

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount#mean

434cde2

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount#min

1b9b4e7

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsResourceCount#refused

7c3ce13

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount

9c8e947

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount#invalid

4d60544

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount#attempted

4ad9ee5

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount#succeeded

b342761

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount#failed

db2d398

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTStatsPushCount#messages

3cc26ff

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit a437698.

Add canonical docstring for ARTStatsPushCount#direct

2af6e2c

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 3b46580.

Add canonical docstring for ARTDeviceDetails

5c53fd6

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit f357c0e.

Add canonical docstring for ARTDeviceDetails#id

13b4a5f

This is taken verbatim from the repo ably/canonical-api-reference-prototyping at commit 7c45391.

ikbalkaya suggested changes Sep 12, 2022

View reviewed changes

ikbalkaya approved these changes Sep 12, 2022

View reviewed changes

maratal added 11 commits September 12, 2022 23:08

Put :nodoc: where docstring generation is not needed

c8b1a71

Added missing description for ARTRestChannelProtocol

3f7780c

Fixed some broken links and docstring tags.

2dad7b7

Added @see section for empty inrerfaces (where all declarations are i…

e4c6314

…n protocol)

Added missing description for ARTHTTPPaginatedResponse

d677107

Fixed broken link.

c5f3993

Added missing description for ARTPush

b227b8c

Put :nodoc: and/or TODO: where docstring generation is not needed (bu…

9c3f625

…t will in some cases be provided in the future PRs)

Removed legacy docstrings

8a8a41c

Removed docstrings BEGIN/END markers

62d1f58

Removed ARTDeltaCodec from public interfaces

cdcaf69

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 00:05 Inactive

Removed ARTDeltaCodec from public headers

0a25f80

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 00:15 Inactive

Moved ARTDeltaCodec to project headers

7470682

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 01:08 Inactive

Fixed more broken links + other final minor fixes

03780d1

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 15:54 Inactive

Fixed more broken links + more final minor fixes

3c9d234

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 20:37 Inactive

Moved ARTDeltaCodec to Private folder

6f8da84

github-actions bot temporarily deployed to staging/pull/1491/jazzydoc September 13, 2022 21:36 Inactive

maratal added 2 commits September 14, 2022 00:52

Reverted all manipulations with ARTDeltaCodec.h (didn't work)

3d6d5dc

Changed framework-root path to "Source" to avoid including ARTDeltaCo…

1bbf885

…dec in the docs.

github-actions bot deployed to staging/pull/1491/jazzydoc September 13, 2022 23:03 View deployment

maratal merged commit e9103c6 into main Sep 13, 2022

maratal deleted the docs/EDX-150-add-canonical-docstring-comments branch September 13, 2022 23:35

maratal mentioned this pull request Sep 14, 2022

ARTCipherParams and ARTCrypto doc comments #1439

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Canonical docstring comments #1491

Canonical docstring comments #1491

maratal commented Aug 24, 2022 •

edited

ikbalkaya left a comment

ikbalkaya left a comment

Canonical docstring comments #1491

Canonical docstring comments #1491

Conversation

maratal commented Aug 24, 2022 • edited

ikbalkaya left a comment

Choose a reason for hiding this comment

ikbalkaya left a comment

Choose a reason for hiding this comment

maratal commented Aug 24, 2022 •

edited