Docs: Autogeneration of pytm model into docs
I maintainer di solito rispondono entro 3 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Non vengono indicati file, test o punti di ingresso. Inizia esaminando la documentazione pytm esistente e il codice sorgente del modello Python, quindi confronta la configurazione proposta di mkdocs, mkdocs-material e mkdocstrings[python] con l'attuale workflow della documentazione del repository. Il lavoro è completato quando la documentazione del modello generata integra la documentazione esistente ed evita che la documentazione manuale del codice sorgente non sia più sincronizzata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Continuous Thread Modeling depends on pytm being as simple to use as possible. Would it help to spread the adoption of pytm if we'd auto-generate docs about the pytm model from source code.
A common approach is using mkdocs + mkdocs-material + mkdocstrings[python] which results in something like this.
This would eliminate the risk of manual docs going out of sync from source code (an important part of the pytm docs) and would complement with already existing docs.
- Lingua principale
- Python
- Stelle
- 1.2k
- Fork
- 237
- Merge medio
- 4g 2h
- PR unite (30g)
- 9
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Include un Dockerfile o un 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 OWASP/pytm
-
Dataflow defaults overwrite values the model set explicitlyForse già presa @markthomaschurch l’ha presa 1 giorno fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 30/100
I maintainer di solito rispondono entro 3 giorni
-
Calling TM.dfd() a second time returns an empty diagramForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 25/100
I maintainer di solito rispondono entro 3 giorni
-
Datastore icon is missing from SVG diagrams (absolute PNG path)Forse già presa @markthomaschurch l’ha presa 3 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 20/100
I maintainer di solito rispondono entro 3 giorni
-
Long boundary names render a literal "\n" in the DFDForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
I maintainer di solito rispondono entro 3 giorni
-
`TM.check()` overwrites explicit Dataflow `protocol`, `dstPort` and `controls.isEncrypted` with sink defaults (regression in 1.4.0)Forse già presa @Svastikkka l’ha presa 14 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 75/100
I maintainer di solito rispondono entro 3 giorni
Issue simili
-
15-minutes 5-minutes algorithm any-language beginner-friendly c cpp csharp easy go good first issue hacktoberfest help wanted java javascript kotlin python rust swift typescript
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Huerte/algo-solutions-python#254 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 86/100
MichaelYcJo/SpecSeal#1543 ·
-
size/s
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
sipyourdrink-ltd/bernstein#7179 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue help wanted python up-for-grabs
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
andrewsiah/agentswarm-data-tasks#309 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno