codex-team/editor.js

Documentation for Inline Tools does not include a static "prepare" method

Open

#2.401 geöffnet am 4. Juli 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (26.602 Stars) (1.985 Forks)batch import
good first issueissue for docs

Beschreibung

Documentation for Inline Tools does not include a static "prepare" method, but it works: https://editorjs.io/inline-tools-api-1/

I think should add a line about it, as in the Block Tunes API: https://editorjs.io/block-tunes-api/

Contributor Guide

Tech Stack
typescript
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
familiarity with markdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
Review the Inline Tools API documentation at https://editorjs.io/inline tools api 1/. Note that it lacks mention of a static `prepare` method, while the Block Tunes API documentation at https://editorjs.io/block tunes api/ includes such a mention. Add a similar note to the Inline Tools page, referencing the `prepare` method's purpose and usage.