Skip to content

docs: add missing, fix existing #10842

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

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

docs: add missing, fix existing #10842

wants to merge 5 commits into from

Conversation

almeidx
Copy link
Member

@almeidx almeidx commented Apr 23, 2025

  • Added missing/Fixed wrong docs
  • Mark protected items as @internal
  • Add missing @mixes tags
  • Avoid unnecessary clones
  • Other random changes

Copy link

vercel bot commented Apr 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview May 24, 2025 3:11pm
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview May 24, 2025 3:11pm

Copy link

codecov bot commented Apr 23, 2025

Codecov Report

Attention: Patch coverage is 89.04110% with 8 lines in your changes missing coverage. Please review.

Project coverage is 42.62%. Comparing base (6efdf3b) to head (275c407).
Report is 18 commits behind head on main.

Files with missing lines Patch % Lines
packages/core/src/client.ts 0.00% 4 Missing ⚠️
packages/builders/src/components/v2/Container.ts 60.00% 2 Missing ⚠️
...ackages/builders/src/components/v2/MediaGallery.ts 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10842      +/-   ##
==========================================
+ Coverage   42.58%   42.62%   +0.03%     
==========================================
  Files         262      262              
  Lines       16133    16125       -8     
  Branches     1549     1567      +18     
==========================================
+ Hits         6871     6874       +3     
+ Misses       9250     9239      -11     
  Partials       12       12              
Flag Coverage Δ
builders 80.52% <92.59%> (+0.03%) ⬆️
core 0.89% <0.00%> (ø)
proxy 65.88% <ø> (ø)
rest 87.62% <100.00%> (-0.14%) ⬇️
voice 70.91% <100.00%> (+0.01%) ⬆️
ws 36.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Qjuh
Qjuh previously requested changes Apr 24, 2025
@github-project-automation github-project-automation bot moved this from Todo to Review in Progress in discord.js Apr 24, 2025
@almeidx almeidx force-pushed the docs/builders branch 2 times, most recently from 181b918 to 30932f4 Compare April 26, 2025 10:05
@almeidx almeidx marked this pull request as ready for review April 26, 2025 10:07
@almeidx almeidx requested review from a team as code owners April 26, 2025 10:07
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request updates documentation and internal annotations across various builder classes while also standardizing construction logic to avoid unnecessary cloning of data. Key changes include adding missing documentation/comments (e.g., @internal and @mixes tags), refining constructor parameter handling, and minor refactors to improve code clarity.

Reviewed Changes

Copilot reviewed 60 out of 60 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/builders/src/components/v2/Separator.ts Added jsdoc for the builder and marked internal properties
packages/builders/src/components/v2/Section.ts Updated docs and refined accessor conversion for the accessory property
packages/builders/src/components/v2/MediaGalleryItem.ts Simplified constructor assignment to avoid an unnecessary spread clone
packages/builders/src/components/v2/MediaGallery.ts Added getter for items and adjusted data cloning logic
packages/builders/src/components/v2/File.ts Modified constructor to destructure file property before cloning data
packages/builders/src/components/v2/Container.ts Introduced a getter for components and standardized constructor handling
Remaining files Primarily doc comment updates and improved internal annotations

Qjuh
Qjuh previously requested changes May 23, 2025
@almeidx almeidx dismissed Qjuh’s stale review May 24, 2025 14:57

Resolved

@almeidx almeidx requested a review from Qjuh May 24, 2025 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Review in Progress
Development

Successfully merging this pull request may close these issues.

4 participants