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): render @defaultValue blocks #8527

Merged
merged 1 commit into from
Aug 19, 2022

Conversation

suneettipirneni
Copy link
Member

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

Members with @defaultValue tags will show their default value in the docs.

@vercel
Copy link

vercel bot commented Aug 19, 2022

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

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

@codecov
Copy link

codecov bot commented Aug 19, 2022

Codecov Report

Merging #8527 (d457642) into main (e475b63) will decrease coverage by 13.54%.
The diff coverage is 100.00%.

@@             Coverage Diff              @@
##              main    #8527       +/-   ##
============================================
- Coverage   100.00%   86.45%   -13.55%     
============================================
  Files           40       87       +47     
  Lines         3797     8462     +4665     
  Branches       560     1105      +545     
============================================
+ Hits          3797     7316     +3519     
- Misses           0     1103     +1103     
- Partials         0       43       +43     
Flag Coverage Δ
builders 100.00% <ø> (ø)
collection 100.00% <ø> (ø)
proxy 73.28% <ø> (?)
rest 92.53% <100.00%> (?)
utilities 100.00% <ø> (?)
voice 64.08% <ø> (?)
ws 59.57% <100.00%> (?)

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

Impacted Files Coverage Δ
packages/rest/src/lib/CDN.ts 97.71% <100.00%> (ø)
packages/rest/src/lib/REST.ts 98.86% <100.00%> (ø)
packages/rest/src/lib/RequestManager.ts 90.22% <100.00%> (ø)
packages/ws/src/ws/WebSocketManager.ts 95.62% <100.00%> (ø)
packages/voice/src/audio/AudioPlayer.ts 80.55% <0.00%> (ø)
packages/voice/src/util/Secretbox.ts 33.33% <0.00%> (ø)
packages/actions/src/formatTag/formatTag.ts 100.00% <0.00%> (ø)
packages/voice/src/VoiceConnection.ts 81.28% <0.00%> (ø)
packages/voice/src/util/entersState.ts 100.00% <0.00%> (ø)
... and 41 more

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

@iCrawl iCrawl merged commit 8028813 into discordjs:main Aug 19, 2022
@Syjalo
Copy link
Contributor

Syjalo commented Aug 19, 2022

Shouldn't it show something like Default value: {value}?

@suneettipirneni
Copy link
Member Author

Shouldn't it show something like Default value: {value}?

It does:
Screen Shot 2022-08-19 at 12 29 44 PM

I assume you're viewing the PR preview, which didn't have the updated api.json being used.

@suneettipirneni suneettipirneni deleted the website/feat/show-defaults branch August 19, 2022 16:30
@Syjalo
Copy link
Contributor

Syjalo commented Aug 19, 2022

Shouldn't it show something like Default value: {value}?

It does: Screen Shot 2022-08-19 at 12 29 44 PM

I assume you're viewing the PR preview, which didn't have the updated api.json being used.

Does this also apply to local launch?

@suneettipirneni
Copy link
Member Author

Does this also apply to local launch?

Yes, if you build the relevant packages before running the website locally it should use the updated api.json.

@Syjalo
Copy link
Contributor

Syjalo commented Aug 19, 2022

Double quotes (``Node.js $process.version``)
image

*/
authPrefix: 'Bot' | 'Bearer';
/**
* The cdn path
*
* @default 'https://cdn.discordapp.com'
* @defaultValue 'https://cdn.discordapp.com'
Copy link
Contributor

Choose a reason for hiding this comment

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

You forgot to put the quotes

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