ueberdosis/tiptap

[Documentation]: NodePos method name setAttribute is misspelled as setAttributes

Open

#4,956 opened on Mar 8, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (1,979 forks)batch import
area: docscomplexity: trivialgood first issueimpact: low

Repository metrics

Stars
 (23,454 stars)
PR merge metrics
 (Avg merge 4d 13h) (46 merged PRs in 30d)

Description

What’s the URL to the page you’re sending feedback for?

https://tiptap.dev/docs/editor/api/nodepos#set-attributes

What part of the documentation needs improvement?

Spell error。

What is helpful about that part?

Documentation should be consistent with code

What is hard to understand, missing or misleading?

The method name should be setAttribute.

Or maybe we should change the method name in the code? To be consistent with other API styles, such as updateAttributes.

Anything to add? (optional)

No response

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.