[Feature Request] Look into alternative API doc generators
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Tranquilla
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia esaminando le pagine attuali generate da pydoctor su python.temporal.io, in particolare WorkerDeploymentConfig, e confronta generatori alternativi di documentazione delle API Python pure come pdoc. Valuta se ciascuno mantiene l'attenzione richiesta sulla documentazione delle sole API e documenta correttamente i campi delle dataclass, incluso default_versioning_behavior; il lavoro è completo quando è presente una raccomandazione documentata o un percorso di migrazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Describe the solution you'd like
We should consider moving away from https://github.com/twisted/pydoctor for Python API docs. It was originally chosen because of how well it handled @overloads. But it doesn't really get updated much and is a bit buggy, e.g. https://python.temporal.io/temporalio.worker.WorkerDeploymentConfig.html is showing those as class variables (because it doesn't understand data classes) and is even missing default_versioning_behavior that is in source with a default.
Open to all options, but I think we want pure API docs generator, not like Sphinx where English docs come along with, but it's worth a try so long as python.temporal.io is pure API docs. Maybe also try https://pdoc.dev/. Or just check around the ecosystem.
- Lingua principale
- Python
- Stelle
- 1.2k
- Fork
- 245
- Merge medio
- 4g 13h
- PR unite (30g)
- 50
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di temporalio/sdk-python
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
temporalio/sdk-python#1897 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
temporalio/sdk-python#496 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug] Heartbeat Task Slot information is not pulled when MetricBuffer is configuredForse già presa @Sushisource l’ha presa 24 giorni fa. Apertabug
temporalio/sdk-python#1817 · 1 commento · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
Cloud CI Skips Nexus TestsForse di nuovo libera @tconley1428 l’ha presa 52 giorni fa e non c’è nessuna pull request aperta. Aperta
temporalio/sdk-python#1704 · 1 assegnatario ·
I maintainer di solito rispondono entro 1 giorno
-
Windows ARM64 wheel supportAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
temporalio/sdk-python#1592 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di temporalio/sdk-python
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
raullenchai/Rapid-MLX#4042 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
LearningCircuit/local-deep-research#7067 ·
I maintainer di solito rispondono entro 1 giorno
-
#bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
apache/superset#44923 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
lawndoc/stack-back#123 ·