Skip to content

docs(use-overlay): typo on unMount method #4047

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.

Sign up for GitHub

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

Jump to bottom
Merged
benjamincanac merged 1 commit into from
May 2, 2025
Merged

docs(use-overlay): typo on unMount method #4047

benjamincanac merged 1 commit into from
May 2, 2025

Conversation

@leyenda
Copy link
Contributor

@leyenda leyenda commented May 2, 2025

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

I was following the documentation but the method unmount should be unMount

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@leyenda
Update use-overlay.md
968a43f 
Typo on method
@leyenda leyenda changed the title fix: typo on method unMount of useOverlay docs: typo on method unMount of useOverlay May 2, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented May 2, 2025 

npm i https://pkg.pr.new/@nuxt/ui@4047

commit: 968a43f

@benjamincanac benjamincanac changed the title docs: typo on method unMount of useOverlay docs(useOverlay): typo on unMount method May 2, 2025
@benjamincanac
Copy link
Member

benjamincanac commented May 2, 2025

@genu Why was it called unMount instead of unmount btw? 🤔

@genu
Copy link
Member

genu commented May 2, 2025

@genu Why was it called unMount instead of unmount btw? 🤔

You're right, unmount is really just one word, it shouldn't have been camelcased... 🤦

We can merge this PR, so the docs are at least right.

In a future PR, we can rename the method from unMount to unmount

@benjamincanac benjamincanac changed the title docs(useOverlay): typo on unMount method docs(use-overlay): typo on unMount method May 2, 2025
@benjamincanac benjamincanac merged commit c23f85f into nuxt:v3 May 2, 2025
6 checks passed
@benjamincanac
Copy link
Member

benjamincanac commented May 2, 2025

Thanks @leyenda! 😊

@benjamincanac benjamincanac added the v3 #1289 label May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benjamincanac benjamincanac benjamincanac approved these changes

Assignees

No one assigned

Labels

v3 #1289

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@leyenda @benjamincanac @genu