sktime/sktime

[BUG] dead links in estimator overview, adding missing estimators to API reference, general testing question

Aperta

#4905 aperta il 18 lug 2023

Vedi su GitHubGuida contributor
 (20 commenti) (0 reazioni) (0 assegnatari)Python (1192 fork)batch import
documentationgood first issuemodule:tests

Metriche repository

Star
 (7162 stelle)
Metriche merge PR
 (Merge medio 26g 10h) (86 PR mergiate in 30 g)

Descrizione

From the query of @olerch below, there are a couple things regarding the estimator overview:

  • a good first issue of reporting missing documentation and/or adding them to the respective API reference page (docs/source/api_reference)
  • an advanced testing question - as the estimator overview automatically detects all estimators, we should be able to detect the ones with dead links too
  • a maintenance question about the estimator overview
  • the dead links end up on sktime-backup, but we should be using the primary sktime readthedocs project.

Discussed in https://github.com/sktime/sktime/discussions/4899

Originally posted by olerch July 17, 2023 I would like to know if it is possible to get all the documentation of the estimators listed on https://www.sktime.net/en/latest/estimator_overview.html? Some documentation is missing and an error page appears when the documentation is called up.

Guida contributor

Direzione di ricerca
Ispeziona i collegamenti morti nella pagina di panoramica degli stimatori e traccia la fonte di tali collegamenti. Considera l'aggiunta degli stimatori mancanti alla documentazione di riferimento API e assicurati che tutti i collegamenti puntino al progetto readthedocs corretto. Per la questione del test, indaga come la panoramica degli stimatori rileva automaticamente gli stimatori e proponi un metodo per rilevare automaticamente i collegamenti morti.
Tech stack
python
Dominio
documentationtesting
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65