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

feat(website): show parameter descriptions #8519

Merged
merged 4 commits into from
Aug 18, 2022

Conversation

suneettipirneni
Copy link
Member

@suneettipirneni suneettipirneni commented Aug 18, 2022

Please describe the changes this PR makes and why it should be merged:

Previously param descriptions would always be "None" despite having descriptions in the source code.

Additionally. this PR tweaks the table resizing. The columns that show types now break in a more legible way, previously the types would be smashed into 1-2 character lines which would render them unreadable in small breakpoints. Tables also now scroll horizonally when the content within them cannot be shrank any farther.

@vercel
Copy link

vercel bot commented Aug 18, 2022

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

Name Status Preview Updated
discord-js ✅ Ready (Inspect) Visit Preview Aug 18, 2022 at 4:34PM (UTC)

@vercel vercel bot temporarily deployed to Preview August 18, 2022 15:41 Inactive
@imranbarbhuiya
Copy link
Contributor

imranbarbhuiya commented Aug 18, 2022

image
it adds this white scrollbar. Is it intentional?

@suneettipirneni
Copy link
Member Author

image it adds this white scrollbar. Is it intentional?

Whoops, that should be fixed. The scroll bar should only show for the table at small breakpoints where the text can't fit.

@vercel vercel bot temporarily deployed to Preview August 18, 2022 15:58 Inactive
@codecov
Copy link

codecov bot commented Aug 18, 2022

Codecov Report

Merging #8519 (02ff2ec) into main (d97cd93) will decrease coverage by 2.99%.
The diff coverage is 100.00%.

❗ Current head 02ff2ec differs from pull request most recent head bf7728a. Consider uploading reports for the commit bf7728a to get more accurate results

@@            Coverage Diff             @@
##             main    #8519      +/-   ##
==========================================
- Coverage   89.37%   86.38%   -3.00%     
==========================================
  Files          66       87      +21     
  Lines        7343     8418    +1075     
  Branches      899     1105     +206     
==========================================
+ Hits         6563     7272     +709     
- Misses        776     1103     +327     
- Partials        4       43      +39     
Flag Coverage Δ
builders 100.00% <100.00%> (ø)
collection 100.00% <100.00%> (ø)
proxy 73.28% <ø> (ø)
rest 92.53% <ø> (ø)
utilities 100.00% <ø> (ø)
voice 64.08% <ø> (?)
ws 59.57% <100.00%> (+0.02%) ⬆️

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

Impacted Files Coverage Δ
packages/builders/src/messages/embed/Embed.ts 100.00% <100.00%> (ø)
packages/collection/src/collection.ts 100.00% <100.00%> (ø)
packages/ws/src/utils/utils.ts 100.00% <100.00%> (ø)
packages/ws/src/ws/WebSocketManager.ts 95.62% <100.00%> (+0.01%) ⬆️
packages/voice/src/util/Secretbox.ts 33.33% <0.00%> (ø)
...ackages/voice/src/util/generateDependencyReport.ts 0.00% <0.00%> (ø)
packages/voice/src/util/entersState.ts 100.00% <0.00%> (ø)
packages/voice/src/audio/AudioResource.ts 95.23% <0.00%> (ø)
packages/voice/src/util/demuxProbe.ts 93.33% <0.00%> (ø)
packages/voice/src/audio/PlayerSubscription.ts 50.00% <0.00%> (ø)
... and 15 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@vercel vercel bot temporarily deployed to Preview August 18, 2022 16:13 Inactive
@vercel vercel bot temporarily deployed to Preview August 18, 2022 16:34 Inactive
@iCrawl iCrawl merged commit 7f415a2 into discordjs:main Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants