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

Improve docs for LogInterceptor #1971

Merged
merged 7 commits into from
Sep 28, 2023
Merged

Improve docs for LogInterceptor #1971

merged 7 commits into from
Sep 28, 2023

Conversation

kuhnroyal
Copy link
Member

New Pull Request Checklist

  • I have read the Documentation
  • I have searched for a similar pull request in the project and found none
  • I have updated this branch with the latest main branch to avoid conflicts (via merge from master or rebase)
  • I have added the required tests to prove the fix/feature I'm adding
  • I have updated the documentation (if necessary)
  • I have run the tests without failures
  • I have updated the CHANGELOG.md in the corresponding package

Additional context and info (if any)

@kuhnroyal kuhnroyal added e: documentation Improvements or additions to documentation p: dio Targeting `dio` package labels Sep 18, 2023
@kuhnroyal kuhnroyal self-assigned this Sep 18, 2023
@kuhnroyal kuhnroyal requested a review from a team as a code owner September 18, 2023 15:43
@kuhnroyal
Copy link
Member Author

@AlexV525 Can you help out with the Chinese translation please :)

ueman
ueman approved these changes Sep 18, 2023
View reviewed changes
Copy link
Contributor

@ueman ueman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dang, good catch

@ueman
Copy link
Contributor

ueman commented Sep 18, 2023

Was there a reason we're not using dart:developer log()?

@kuhnroyal
Copy link
Member Author

History show it has always used print. I never directly used dart:developer log(), not sure how this differs from debugPrint.

@ueman
Copy link
Contributor

ueman commented Sep 18, 2023

History show it has always used print. I never directly used dart:developer log(), not sure how this differs from debugPrint.

log isn't throttled, but it only prints during debug mode, but not during release mode.

@AlexV525
Copy link
Member

AlexV525 commented Sep 19, 2023 •
edited
Loading

I've been using log for a while, it is unthrottled, but it still regress performance for massive contents (under DEBUG mode). And sometimes people want logs visible from the native side (e.g. logcat) so they need print. We can recommend it too in docs and comments though.

@AlexV525
Copy link
Member

@AlexV525 Can you help out with the Chinese translation please :)

Looks like we can have more modifications, I'll wait until then.

@AlexV525 AlexV525 added this pull request to the merge queue Sep 28, 2023
Merged via the queue into cfug:main with commit 4d7ea68 Sep 28, 2023
34 checks passed
@kuhnroyal kuhnroyal deleted the improve-log-interceptor-doc branch January 2, 2024 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ueman ueman ueman approved these changes

Assignees

@kuhnroyal kuhnroyal

Labels
e: documentation Improvements or additions to documentation p: dio Targeting `dio` package
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

LogInterceptor causes connection loss in Flutter version 3.13.x
3 participants
@kuhnroyal @ueman @AlexV525