Skip to content

refactor(website): search index name of members includes class now #10415

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

Merged
merged 4 commits into from
Aug 2, 2024

Conversation

Qjuh
Copy link
Member

@Qjuh Qjuh commented Jul 30, 2024

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

Previously the search index for e.g. GuildMember#guild had just guild as name for the entry and only the path it links to and maybe the description told you what class it belongs to.

With this small change the name now includes the Classname too and also distinguishes methods from properties. I.e. fetch is now GuildMember.fetch().

Status and versioning classification:

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

@Qjuh Qjuh requested a review from a team as a code owner July 30, 2024 13:07
Copy link

vercel bot commented Jul 30, 2024

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 Aug 1, 2024 9:24am
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Aug 1, 2024 9:24am

Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.79%. Comparing base (48682ad) to head (cf0ac6c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10415   +/-   ##
=======================================
  Coverage   50.79%   50.79%           
=======================================
  Files         228      228           
  Lines       20689    20689           
  Branches     1258     1258           
=======================================
  Hits        10508    10508           
  Misses      10137    10137           
  Partials       44       44           
Flag Coverage Δ
brokers 64.14% <ø> (ø)
builders 95.78% <ø> (ø)
collection 100.00% <ø> (ø)
formatters 99.34% <ø> (ø)
proxy 78.52% <ø> (ø)
rest 92.68% <ø> (ø)
util 68.86% <ø> (ø)
utilities 100.00% <ø> (ø)
voice 63.64% <ø> (ø)
ws 52.01% <ø> (ø)

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.

@kodiakhq kodiakhq bot merged commit bb459d9 into discordjs:main Aug 2, 2024
24 checks passed
@Qjuh Qjuh deleted the scripts/searchindex-scoped-name branch September 14, 2024 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants