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

Incorrect import path style in @lit-labs/observers documentation #1381

Closed
Masty88 opened this issue Oct 29, 2024 · 0 comments
Closed

Incorrect import path style in @lit-labs/observers documentation #1381

Masty88 opened this issue Oct 29, 2024 · 0 comments

Comments

@Masty88
Copy link

Masty88 commented Oct 29, 2024

Current Behavior

The README example for MutationController shows an import path using snake_case:

import {MutationController} from '@lit-labs/observers/mutation_controller.js';

Expected Behavior

The import path should use kebab-case to match the actual file name convention:

import {MutationController} from '@lit-labs/observers/mutation-controller.js';

Impact

  • Users copying the example from the documentation will get a 404 error since the file path doesn't exist
  • Inconsistent with project's file naming conventions

Additional Context

This is a documentation-only fix to ensure examples in the documentation match the actual implementation.

@Masty88 Masty88 closed this as completed Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant