[ECO-4804] Update ably-js logging docs

ably / docs

Ably Realtime API documentation

https://ably.com/docs

Apache License 2.0

20 stars 40 forks source link

[ECO-4804] Update ably-js logging docs #2199

Closed lawrence-forooghian closed 2 months ago

lawrence-forooghian commented 3 months ago

Description

Updates the logging documentation for ably-js:

log was split into logLevel and logHandler (to conform with the spec) in ably-js v2.
The global effect of setting logging configuration was removed in https://github.com/ably/ably-js/commit/5502a43 and will be released in 2.1.0.

Resolves https://github.com/ably/ably-js/issues/1766.

Review

See the logLevel and logHandler documentation on this page.

lawrence-forooghian commented 3 months ago

@m-hulbert I’m a bit confused about whether this can be merged or not. The documentation says "This API reference is for version 1.2 of the JavaScript SDK. Version 2.0 references are available in TypeDoc.", but the version dropdown says "v2.0". Can the v2-related changes in this PR be merged?

jamienewcomb commented 2 months ago

hey @lawrence-forooghian @m-hulbert

this has been in review for over a month now. do we still need this? if not I suggest we just close the PR

lawrence-forooghian commented 2 months ago

I think it can't be merged right now since the documentation is still for ably-js v2. But that seems like something we need to address. Whether there's a plan for doing that in the near term, I don't know.

m-hulbert commented 2 months ago

This is dependent on an internal DR for API reference versioning at the moment.

I will close it for now and make a reference to it in the JIRA I have for versioning the JS API references.