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.

Sign up for GitHub

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

Jump to bottom

Update to canonical doc #556

Merged
merged 79 commits into from
Jan 4, 2023
Merged

Update to canonical doc #556

merged 79 commits into from
Jan 4, 2023

Commits on Oct 10, 2022

  1. Marked existing doc comments as legacy

    @sacOO7
    sacOO7 committed Oct 10, 2022
    Configuration menu
    Copy the full SHA
    e59344b View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2022

  1. Marked more doc comments as legacy

    @sacOO7
    sacOO7 committed Oct 11, 2022
    Configuration menu
    Copy the full SHA
    031f91d View commit details
    Browse the repository at this point in the history

  2. Marked connection close doc comment as legacy

    @sacOO7
    sacOO7 committed Oct 11, 2022
    Configuration menu
    Copy the full SHA
    bdf5a2f View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2022

  1. Added canonical doc comments for rest client

    @sacOO7
    sacOO7 committed Oct 19, 2022
    Configuration menu
    Copy the full SHA
    21fb314 View commit details
    Browse the repository at this point in the history

Commits on Oct 23, 2022

  1. Updated rest client with canonical documentation

    @sacOO7
    sacOO7 committed Oct 23, 2022
    Configuration menu
    Copy the full SHA
    ff0e6d0 View commit details
    Browse the repository at this point in the history

Commits on Nov 2, 2022

  1. Added documentation for realtime-client

    @sacOO7
    sacOO7 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    aa75cdc View commit details
    Browse the repository at this point in the history

  2. Marked comments under options as legacy

    @sacOO7
    sacOO7 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    afcb318 View commit details
    Browse the repository at this point in the history

  3. Added canonical comments to realtime client

    @sacOO7
    sacOO7 committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    fccd61a View commit details
    Browse the repository at this point in the history

Commits on Nov 3, 2022

  1. Added canonical docstrings to realtime client, rest client and options

    @sacOO7
    sacOO7 committed Nov 3, 2022
    Configuration menu
    Copy the full SHA
    2bb3c56 View commit details
    Browse the repository at this point in the history

Commits on Nov 4, 2022

  1. Added canonical docstrings for token

    @sacOO7
    sacOO7 committed Nov 4, 2022
    Configuration menu
    Copy the full SHA
    d4fa591 View commit details
    Browse the repository at this point in the history

  2. Added canonical doc for token and auth

    @sacOO7
    sacOO7 committed Nov 4, 2022
    Configuration menu
    Copy the full SHA
    5cab697 View commit details
    Browse the repository at this point in the history

Commits on Nov 7, 2022

  1. Added canonical doc to realtime channel

    @sacOO7
    sacOO7 committed Nov 7, 2022
    Configuration menu
    Copy the full SHA
    2ebc232 View commit details
    Browse the repository at this point in the history

  2. Added canonical doc for the token

    @sacOO7
    sacOO7 committed Nov 7, 2022
    Configuration menu
    Copy the full SHA
    c9f29d3 View commit details
    Browse the repository at this point in the history

Commits on Nov 9, 2022

  1. Added canonical doc for rest channel

    @sacOO7
    sacOO7 committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    75d0493 View commit details
    Browse the repository at this point in the history

  2. Added canonical doc for realtime channel

    @sacOO7
    sacOO7 committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    366ee3c View commit details
    Browse the repository at this point in the history

  3. Added canonical doc for proto channel options

    @sacOO7
    sacOO7 committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    6f13fdc View commit details
    Browse the repository at this point in the history

  4. Added canonical doc for channel state

    @sacOO7
    sacOO7 committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    b41fb15 View commit details
    Browse the repository at this point in the history

Commits on Nov 10, 2022

  1. Added documentation to proto_crypto and crypto

    @sacOO7
    sacOO7 committed Nov 10, 2022
    Configuration menu
    Copy the full SHA
    4748fa5 View commit details
    Browse the repository at this point in the history

  2. Added canonical doc to realtime channel

    @sacOO7
    sacOO7 committed Nov 10, 2022
    Configuration menu
    Copy the full SHA
    2028d8a View commit details
    Browse the repository at this point in the history

  3. added canonical doc to realtime presence

    @sacOO7
    sacOO7 committed Nov 10, 2022
    Configuration menu
    Copy the full SHA
    cc7475b View commit details
    Browse the repository at this point in the history

  4. Added canonical doc to rest channel

    @sacOO7
    sacOO7 committed Nov 10, 2022
    Configuration menu
    Copy the full SHA
    be8ae27 View commit details
    Browse the repository at this point in the history

  5. Added canonical doc to rest presence

    @sacOO7
    sacOO7 committed Nov 10, 2022
    Configuration menu
    Copy the full SHA
    2b82c9c View commit details
    Browse the repository at this point in the history

Commits on Nov 11, 2022

  1. Added canonical doc to presence action

    @sacOO7
    sacOO7 committed Nov 11, 2022
    Configuration menu
    Copy the full SHA
    076edc1 View commit details
    Browse the repository at this point in the history

  2. Added canonical doc to Message struct

    @sacOO7
    sacOO7 committed Nov 11, 2022
    Configuration menu
    Copy the full SHA
    2a20965 View commit details
    Browse the repository at this point in the history

  3. Added canonical doc to connectionDetails struct

    @sacOO7
    sacOO7 committed Nov 11, 2022
    Configuration menu
    Copy the full SHA
    51a63c2 View commit details
    Browse the repository at this point in the history

  4. Added canonical doc to realtime presence methods

    @sacOO7
    sacOO7 committed Nov 11, 2022
    Configuration menu
    Copy the full SHA
    a3947b8 View commit details
    Browse the repository at this point in the history

Commits on Nov 13, 2022

  1. Added documentation related to connection states and state changes

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    1a804e7 View commit details
    Browse the repository at this point in the history

  2. Added documentation related to authDetails

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    eee294b View commit details
    Browse the repository at this point in the history

  3. Added documentation for realtime connection

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    cde5d4b View commit details
    Browse the repository at this point in the history

  4. Added canonical doc for stats and related types

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    198c304 View commit details
    Browse the repository at this point in the history

  5. Added canonical doc for error

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    0282602 View commit details
    Browse the repository at this point in the history

  6. Added canonical doc for event emitter

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    de61740 View commit details
    Browse the repository at this point in the history

  7. Added canonical doc for httpPaginatedResponse rest client

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    ff42eea View commit details
    Browse the repository at this point in the history

  8. Removed legacy comments from ablyutils

    @sacOO7
    sacOO7 committed Nov 13, 2022
    Configuration menu
    Copy the full SHA
    dc19290 View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2022

  1. Updated README for opening local godoc

    @sacOO7
    sacOO7 committed Nov 15, 2022
    Configuration menu
    Copy the full SHA
    4b6882d View commit details
    Browse the repository at this point in the history

  2. removed legacy comments

    @sacOO7
    sacOO7 committed Nov 15, 2022
    Configuration menu
    Copy the full SHA
    5bea8f2 View commit details
    Browse the repository at this point in the history

Commits on Nov 16, 2022

  1. Retained legacy comments without canonical comments.

    @sacOO7
    sacOO7 committed Nov 16, 2022
    Configuration menu
    Copy the full SHA
    9fb262b View commit details
    Browse the repository at this point in the history

  2. Retained legacy comments without canonical comments for core files

    @sacOO7
    sacOO7 committed Nov 16, 2022
    Configuration menu
    Copy the full SHA
    7a4272d View commit details
    Browse the repository at this point in the history

Commits on Nov 17, 2022

  1. Retained legacy comments without canonical comments for utils and cor… 

    …e files
    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    cd41cd3 View commit details
    Browse the repository at this point in the history

  2. Added overview doc for go SDK

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    86739b3 View commit details
    Browse the repository at this point in the history

  3. Refactored canonical doc for auth to language-specific comments

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    c66135d View commit details
    Browse the repository at this point in the history

  4. Refactored canonical doc for crypto to language-specific comments

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    f3141a8 View commit details
    Browse the repository at this point in the history

  5. Refactored canonical doc for error to language-specific comments

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    8946af7 View commit details
    Browse the repository at this point in the history

  6. Refactored canonical doc for event_emitter to language-specific comments

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    e4575e8 View commit details
    Browse the repository at this point in the history

  7. Refactored canonical doc for merge to language-specific comments

    @sacOO7
    sacOO7 committed Nov 17, 2022
    Configuration menu
    Copy the full SHA
    4313f3a View commit details
    Browse the repository at this point in the history

Commits on Nov 19, 2022

  1. Refactored logger comment for a logger interface

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    d902861 View commit details
    Browse the repository at this point in the history

  2. Refactored canonical doc for authUrl/authCallback to lang specific doc

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    df627f8 View commit details
    Browse the repository at this point in the history

  3. Refactored canonical doc for options apikey to lang specific doc

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    fb180e5 View commit details
    Browse the repository at this point in the history

  4. Refactored canonical doc for authOptions to lang specific doc

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    fbebde5 View commit details
    Browse the repository at this point in the history

  5. Refactored canonical doc for clientOptions to lang specific doc

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    616b6aa View commit details
    Browse the repository at this point in the history

  6. Refactored canonical doc for remaining clientOptions to lang specific… 

    … doc
    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    3240a88 View commit details
    Browse the repository at this point in the history

  7. Refactored canonical doc for channel options to lang specific doc

    @sacOO7
    sacOO7 committed Nov 19, 2022
    Configuration menu
    Copy the full SHA
    4925541 View commit details
    Browse the repository at this point in the history

Commits on Nov 20, 2022

  1. Refactored canonical doc for proto channel options to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    0e9f0de View commit details
    Browse the repository at this point in the history

  2. Refactored canonical doc for proto crypto to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    f58f90c View commit details
    Browse the repository at this point in the history

  3. Refactored canonical doc for proto message to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    f147f04 View commit details
    Browse the repository at this point in the history

  4. Refactored canonical doc for proto presence message to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    0fa63de View commit details
    Browse the repository at this point in the history

  5. Refactored canonical doc for proto protocol message to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    024f869 View commit details
    Browse the repository at this point in the history

  6. Refactored canonical doc for proto stat to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    332a7bd View commit details
    Browse the repository at this point in the history

  7. Refactored canonical doc for proto types to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    9e9d585 View commit details
    Browse the repository at this point in the history

  8. Refactored canonical doc for realtime channel to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    b441103 View commit details
    Browse the repository at this point in the history

  9. Updated README for generating and viewing godoc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    5cbf48a View commit details
    Browse the repository at this point in the history

  10. Refactored canonical doc for realtime client to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    4453ea3 View commit details
    Browse the repository at this point in the history

  11. Refactored canonical doc for realtime conn to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    140b0a0 View commit details
    Browse the repository at this point in the history

  12. Refactored canonical doc for realtime presence to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    7fecc24 View commit details
    Browse the repository at this point in the history

  13. Refactored canonical doc for rest channel to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    82d802c View commit details
    Browse the repository at this point in the history

  14. Refactored canonical doc for rest client to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    5be944c View commit details
    Browse the repository at this point in the history

  15. Refactored canonical doc for rest presence to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    4d9ab0c View commit details
    Browse the repository at this point in the history

  16. Refactored canonical doc for token to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    4015fb2 View commit details
    Browse the repository at this point in the history

  17. Refactored canonical doc for state to lang specific doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    0f10f74 View commit details
    Browse the repository at this point in the history

  18. Fixed realtimepresence unsubscribeall canonical doc

    @sacOO7
    sacOO7 committed Nov 20, 2022
    Configuration menu
    Copy the full SHA
    0617e7d View commit details
    Browse the repository at this point in the history

Commits on Nov 25, 2022

  1. Moved web-based godoc from README to CONTRIBUTING

    @sacOO7
    sacOO7 committed Nov 25, 2022
    Configuration menu
    Copy the full SHA
    6dade3d View commit details
    Browse the repository at this point in the history

Commits on Dec 1, 2022

  1. Removed warning for gopages only unix based system

    @sacOO7
    sacOO7 committed Dec 1, 2022
    Configuration menu
    Copy the full SHA
    83a265b View commit details
    Browse the repository at this point in the history

Commits on Dec 23, 2022

  1. formatted using gofmt

    @sacOO7
    sacOO7 committed Dec 23, 2022
    Configuration menu
    Copy the full SHA
    b5540bf View commit details
    Browse the repository at this point in the history

  2. Fixed doc comments for auth.go options

    @sacOO7
    sacOO7 committed Dec 23, 2022
    Configuration menu
    Copy the full SHA
    f58155d View commit details
    Browse the repository at this point in the history

  3. Added section for previewing godoc locally

    @sacOO7
    sacOO7 committed Dec 23, 2022
    Configuration menu
    Copy the full SHA
    c8b8f3e View commit details
    Browse the repository at this point in the history

Commits on Jan 4, 2023

  1. Merge branch 'main' into fix/add-canonical-docstring-comments 

    # Conflicts:
#	ably/auth.go
#	ably/proto_crypto.go
#	ably/proto_message.go
    @sacOO7
    sacOO7 committed Jan 4, 2023
    Configuration menu
    Copy the full SHA
    6e1a824 View commit details
    Browse the repository at this point in the history

  2. Gate gofmt Go runtime version using GitHub workflow syntax, rather th… 

    …an bash script.
    @QuintinWillison
    QuintinWillison committed Jan 4, 2023
    Configuration menu
    Copy the full SHA
    f224fdb View commit details
    Browse the repository at this point in the history

  3. gofmt -w .

    @QuintinWillison
    QuintinWillison committed Jan 4, 2023
    Configuration menu
    Copy the full SHA
    38ca5ff View commit details
    Browse the repository at this point in the history

  4. Merge branch 'main' into fix/add-canonical-docstring-comments

    @QuintinWillison
    QuintinWillison committed Jan 4, 2023
    Configuration menu
    Copy the full SHA
    9342c63 View commit details
    Browse the repository at this point in the history