Improve in-code documentation
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 20/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par examiner la base de code Python à la recherche de pydocs manquantes et par passer en revue les PRs proposées mentionnées dans l’issue. Le périmètre couvre la documentation et les exemples dans la quasi-totalité du code, ainsi qu’une politique visant à empêcher les PRs non documentées. Pour considérer le travail comme terminé, il faudrait disposer d’une approche convenue et d’une couverture étendue de la documentation manquante.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
- Langage dominant
- Python
- Étoiles
- 342
- Forks
- 65
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de cloudevents/sdk-python
-
Kafka `to_binary()` crashes on events without `datacontenttype` or with non-string attributesOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
cloudevents/sdk-python#304 ·
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
cloudevents/sdk-python#300 ·
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
cloudevents/sdk-python#291 · 8 commentaires ·
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 48/100
cloudevents/sdk-python#247 · 2 commentaires ·
-
question
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
cloudevents/sdk-python#246 · 5 commentaires ·
Toutes les issues de cloudevents/sdk-python
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 88/100
BasedHardware/omi#20271 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 92/100
openai/openai-cookbook#3153 ·
Les mainteneurs répondent en général sous 1 jour
-
cvss-severity:high devguard l3montree-cybersecurity/devguard/devguard pkg:golang/github.com/l3montree-dev/devguard risk:low state:open
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
l3montree-dev/devguard#3146 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
bug confirmed issue
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
open-webui/open-webui#31849 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour