expressjs/expressjs.com

Add API docs for router(req, res, [next])

Open

#1.151 geöffnet am 15. Mai 2020

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)CSS (5.330 Stars) (2.088 Forks)batch import
enhancementhelp wanted

Beschreibung

The instance function router(req, res, [next]) I can't find documented in the API docs. We should get it listed there and documented, somewhere in the http://expressjs.com/en/4x/api.html#router section.

The same docs would be in the 4x and 5x API docs.

Contributor Guide

Tech Stack
nodejsjavascript
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Express.js basicsJSDoc knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80
Research-Richtung
The issue requests adding documentation for the router function `router(req, res, [next])` in the Express API docs (http://expressjs.com/en/4x/api.html#router). Examine the existing API doc structure and the 4x and 5x versions to determine where to add the new documentation. There are no linked pull requests, so this is a fresh documentation addition.