3 code samples in your docs no longer compile

Aperta Adatta ai principianti
#4,782 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

  • #5018 di @KeuqS — chiusa senza merge

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Parti dalla pagina della documentazione https://trigger.dev/docs/ai/prompts, sezione 'Prompts ’ Type utilities', e individua il file sorgente nel repo (cerca nella directory docs gli identificatori PromptHandle, PromptIdentifier, PromptVariables). Verifica rispetto alle dichiarazioni .d.ts pubblicate di @trigger.dev/sdk che questi export sono scomparsi, poi elimina o riscrivi i tre esempi affinché superino il controllo dei tipi. È concluso quando snippetcheck non segnala più export rimossi per quella pagina.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I ran snippetcheck against the trigger-dev-sdk docs — it type-checks every TypeScript sample in a docs site against the package's own published declarations, nothing executed.

Against @trigger.dev/[email protected], 3 findings marked included after review:

Kind Symbol Section Page
removed-export PromptHandle Prompts > Type utilities https://trigger.dev/docs/ai/prompts
removed-export PromptIdentifier Prompts > Type utilities https://trigger.dev/docs/ai/prompts
removed-export PromptVariables Prompts > Type utilities https://trigger.dev/docs/ai/prompts

Method: type-checked against the package's own .d.ts declarations, nothing executed. 267 of 970 extracted TypeScript samples checked. Skipped: 63 before-example, 117 historical-section, 230 no-target-import, 2 unsupported-language, 1 unparseable.

Happy to share the full report, or re-run this after your next release.

— David

Lingua principale
TypeScript
Stelle
16.5k
Fork
1.5k
Merge medio
1g 15h
PR unite (30g)
17

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di triggerdotdev/trigger.dev

Tutte le issue di triggerdotdev/trigger.dev

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.