Skip to content

docs: fix for inclusive language #30106

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
merged 2 commits into from
Dec 1, 2024
Merged

docs: fix for inclusive language #30106

merged 2 commits into from
Dec 1, 2024

Conversation

ineshbose
Copy link
Member

@ineshbose ineshbose commented Dec 1, 2024 •
edited by coderabbitai bot
Loading

🔗 Linked issue

📚 Description

Summary by CodeRabbit

  • Documentation
    • Revised documentation for the useHeadSafe composable to clarify its role and usage.
    • Updated terminology from "whitelist" to "list of allowed values" for inclusivity.
    • Included example usage illustrating the processing of unsafe values.
    • Maintained the list of safe attributes for HTML elements and provided a reference to @unhead/schema for detailed types.

@ineshbose ineshbose requested a review from danielroe as a code owner December 1, 2024 15:24
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@ineshbose ineshbose changed the title docs: use inclusive language docs: fix for inclusive language Dec 1, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Dec 1, 2024 •
edited
Loading

Walkthrough

The pull request updates the documentation for the useHeadSafe composable, clarifying its role as a wrapper around the useHead composable. It emphasizes that it restricts input to safe values and provides an example of handling unsafe values. The terminology has been updated from "whitelist" to "list of allowed values," and the list of safe attributes for various HTML elements has been retained. References to @unhead/schema for detailed types related to safe values are included, but the type signature for the function remains unchanged.

Changes

File Change Summary
docs/3.api/2.composables/use-head-safe.md Updated documentation to clarify functionality, added example usage, changed "whitelist" to "list of allowed values," retained safe attributes list, and added references.

Possibly related PRs

  • docs: typo in use-seo-meta.md #29930: The changes in the documentation for useSeoMeta involve clarifying example usage, similar to how the useHeadSafe documentation was updated to clarify its functionality and usage.

Poem

🐇 In the garden of code, we hop with glee,
useHeadSafe shines bright, as safe as can be.
With attributes guarded, and examples to show,
Our docs are now clearer, let knowledge grow!
So here’s to the changes, let’s celebrate right,
A safer tomorrow, in the code’s gentle light! 🌟

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bd5afd8 and a9c007e.

📒 Files selected for processing (1)
  • docs/3.api/2.composables/use-head-safe.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/3.api/2.composables/use-head-safe.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

danielroe
danielroe reviewed Dec 1, 2024
View reviewed changes
@danielroe danielroe merged commit 2ea7388 into nuxt:main Dec 1, 2024
7 of 8 checks passed
@github-actions github-actions bot mentioned this pull request Dec 1, 2024
Merged
danielroe pushed a commit that referenced this pull request Dec 3, 2024
@ineshbose @danielroe
docs: improve wording (#30106)
5b3476a
@github-actions github-actions bot mentioned this pull request Dec 2, 2024
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@ineshbose @Kamsou
docs: improve wording (nuxt#30106)
34884a0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ineshbose @danielroe
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy