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

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

Closed
wants to merge 1 commit into from
Closed

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

wants to merge 1 commit into from

Conversation

lawrence-forooghian
Copy link
Contributor

@lawrence-forooghian lawrence-forooghian commented May 29, 2024 •
edited
Loading

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 ably/ably-js@5502a43 and will be released in 2.1.0.

Resolves ably/ably-js#1766.

Review

See the logLevel and logHandler documentation on this page.

@ably-ci ably-ci temporarily deployed to ably-docs-eco-4804-upda-yxnwxj May 29, 2024 16:52 Inactive
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4804-update-ably-js-logging-docs branch from 92d02b0 to aa88a34 Compare May 29, 2024 17:27
@lawrence-forooghian
Update logging documentation for ably-js
4fde4df 
- `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
  ably-js commit 5502a43 and will be released in 2.1.0.

Resolves ably/ably-js#1766.
@lawrence-forooghian lawrence-forooghian force-pushed the ECO-4804-update-ably-js-logging-docs branch from aa88a34 to 4fde4df Compare May 29, 2024 17:41
@lawrence-forooghian lawrence-forooghian mentioned this pull request May 29, 2024
Closed
@denissellu denissellu temporarily deployed to ably-docs-eco-4804-upda-yxnwxj May 29, 2024 17:43 Inactive
@lawrence-forooghian
Copy link
Contributor Author

@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?

@lawrence-forooghian lawrence-forooghian changed the title [ECO-4804] (WIP) Update ably-js logging docs [ECO-4804] Update ably-js logging docs May 29, 2024
@lawrence-forooghian lawrence-forooghian marked this pull request as ready for review May 29, 2024 20:06
@jamienewcomb
Copy link
Member

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
Copy link
Contributor Author

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
Copy link
Contributor

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.

@m-hulbert m-hulbert closed this Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-hulbert m-hulbert Awaiting requested review from m-hulbert

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update logging client options documentation on ably.com
5 participants
@lawrence-forooghian @jamienewcomb @m-hulbert @denissellu @ably-ci