catchorg/Catch2

The documentation needs updating for v3

Open

#2050 aperta il 10 ott 2020

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)C++ (3228 fork)batch import
DocumentationGood First Issue

Metriche repository

Star
 (20.381 star)
Metriche merge PR
 (Merge medio 4g 16h) (2 PR mergiate in 30 g)

Descrizione

As an example, the "Getting started" documentation still talks about CATCH_CONFIG_MAIN macro.

Guida contributor

Direzione di ricerca
Individua il file di documentazione 'Getting started' nel repository Catch2. Probabilmente si trova nella directory 'docs'. Cerca la stringa 'CATCH CONFIG MAIN' e sostituiscila con la macro appropriata per v3. 'CATCH CONFIG MAIN' è deprecata; la nuova macro è 'CATCH CONFIG MAIN' non presente in v3? In realtà, Catch2 v3 ha rimosso 'CATCH CONFIG MAIN'; usare 'CATCH CONFIG MAIN'? Aspetta, è meglio controllare la documentazione o il changelog di v3. Guarda i commenti dell'issue per la discussione sulla sostituzione corretta. La correzione dovrebbe essere semplice: aggiornare il nome della macro e qualsiasi testo correlato per corrispondere all'API v3 attuale.
Tech stack
cpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90