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: use remarks instead of Note in descriptions #8597

Merged
merged 1 commit into from Sep 5, 2022

Conversation

almeidx
Copy link
Member

@almeidx almeidx commented Sep 5, 2022

Please describe the changes this PR makes and why it should be merged:
Replaces "Note"s in summaries with @remarks

I copied the toJSON() note from the Component class because it seemed more complete

/**
* Serializes this component to an API-compatible JSON object
*
* @remarks
* This method runs validations on the data before serializing it.
* As such, it may throw an error if the data is invalid.
*/
public abstract toJSON(): AnyAPIActionRowComponent;

Status and versioning classification:

  • This PR only includes non-code changes, like changes to documentation, README, etc.

@vercel
Copy link

vercel bot commented Sep 5, 2022

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

1 Ignored Deployment
Name Status Preview Updated
discord-js ⬜️ Ignored (Inspect) Sep 5, 2022 at 3:26PM (UTC)

@codecov
Copy link

codecov bot commented Sep 5, 2022

Codecov Report

Merging #8597 (73a637d) into main (4ffdada) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #8597   +/-   ##
=======================================
  Coverage   86.47%   86.48%           
=======================================
  Files          87       87           
  Lines        8675     8679    +4     
  Branches     1110     1110           
=======================================
+ Hits         7502     7506    +4     
  Misses       1131     1131           
  Partials       42       42           
Flag Coverage Δ
builders 100.00% <100.00%> (ø)
collection 100.00% <ø> (ø)
proxy 74.10% <ø> (ø)
rest 91.99% <ø> (ø)
utilities 100.00% <ø> (ø)
voice 63.86% <ø> (ø)
ws 60.40% <ø> (ø)

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

Impacted Files Coverage Δ
...s/contextMenuCommands/ContextMenuCommandBuilder.ts 100.00% <100.00%> (ø)
.../interactions/slashCommands/SlashCommandBuilder.ts 100.00% <100.00%> (ø)

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

@iCrawl iCrawl merged commit f3ce4a7 into discordjs:main Sep 5, 2022
@almeidx almeidx deleted the remarks branch September 5, 2022 16:23
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.

None yet

3 participants