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.

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

docs(log): document public interfaces #6006

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

kt3k
Copy link
Member

@kt3k kt3k commented Sep 18, 2024

This PR fixes the errors from the command deno doc --lint log/mod.ts

@github-actions github-actions bot added the log label Sep 18, 2024
@kt3k kt3k requested a review from iuioiua September 18, 2024 05:20
Copy link

codecov bot commented Sep 18, 2024

Codecov Report

Attention: Patch coverage is 88.52459% with 7 lines in your changes missing coverage. Please review.

Project coverage is 96.28%. Comparing base (77eba7f) to head (4520650).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
log/console_handler.ts 25.00% 3 Missing ⚠️
log/base_handler.ts 83.33% 2 Missing ⚠️
log/logger.ts 89.47% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6006      +/-   ##
==========================================
- Coverage   96.29%   96.28%   -0.01%     
==========================================
  Files         493      493              
  Lines       39528    39594      +66     
  Branches     5832     5837       +5     
==========================================
+ Hits        38062    38122      +60     
- Misses       1424     1430       +6     
  Partials       42       42              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@iuioiua iuioiua left a comment

Choose a reason for hiding this comment

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

Maybe we should clarify the title, as this PR only adds descriptions to public APIs.

log/base_handler.ts Outdated Show resolved Hide resolved
@iuioiua
Copy link
Collaborator

iuioiua commented Sep 18, 2024

Also, I feel like these descriptions aren't particularly informative 😬

Co-authored-by: Asher Gomez <[email protected]>
@kt3k
Copy link
Member Author

kt3k commented Sep 18, 2024

Also, I feel like these descriptions aren't particularly informative 😬

At least this reduces lots of lint errors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants