Skip to content

Docs: Remove alias Hiliter for Highlighter#9088

Merged
henon merged 2 commits intoMudBlazor:devfrom
Olivervesth:misspelled-Highlighter-fix
May 30, 2024
Merged

Docs: Remove alias Hiliter for Highlighter#9088
henon merged 2 commits intoMudBlazor:devfrom
Olivervesth:misspelled-Highlighter-fix

Conversation

@Olivervesth
Copy link
Contributor

Description

Simple misspelling in MudBlazor\src\MudBlazor.Docs\Services\ApiLink\ApiLinkService.cs
in RegisterAliases() the string was saying "Hiliter" this is now changed to "Highlighter"

Type of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (fix or improvement to the website or code docs)

image
image

Checklist

  • The PR is submitted to the correct branch (dev).
  • My code follows the code style of this project.
  • I've added relevant tests.

@github-actions github-actions bot added bug Unexpected behavior or functionality not working as intended PR: needs review labels May 30, 2024
@codecov
Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.65%. Comparing base (28bc599) to head (70eeee1).
Report is 244 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #9088      +/-   ##
==========================================
+ Coverage   89.82%   90.65%   +0.82%     
==========================================
  Files         412      398      -14     
  Lines       11878    12382     +504     
  Branches     2364     2406      +42     
==========================================
+ Hits        10670    11225     +555     
+ Misses        681      620      -61     
- Partials      527      537      +10     

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

@ScarletKuro ScarletKuro added docs Updates/improvements to project documentation that do not affect core library logic and removed bug Unexpected behavior or functionality not working as intended labels May 30, 2024
@Anu6is
Copy link
Contributor

Anu6is commented May 30, 2024

This looks to me like Hiliter was an intentional misspelling. The items added to RegisterAliases are meant to be aliases with their results indicating Go to xxx as a way to redirect the user when they searched for a component via known synonym, for example
image

The comment in the method states

// Add search texts here which users might search and direct them to the correct component or page.

image

If Hiliter was changed to maybe Hilighter or some other misspelling, that may be more appropriate.
Alternatively, removing it completely or of course leaving it as is are options.

I'd vote for removal since Hiliter correctly returns Highlighter ... eliminating the need for a redirect.

@henon
Copy link
Contributor

henon commented May 30, 2024

Yes we can remove it. Our search is now fuzzy so it will still be found if someone types Hiliter

@henon henon changed the title Misspelled Highlighter fixed Docs: Remove alias Hiliter for Highlighter May 30, 2024
@henon henon merged commit eb322b1 into MudBlazor:dev May 30, 2024
@henon
Copy link
Contributor

henon commented May 30, 2024

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Updates/improvements to project documentation that do not affect core library logic

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants