Being more explicit with documenting public API
Les mainteneurs répondent en général sous 10 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- api, developer-experience
Piste de recherche
Commencez par examiner la discussion dans la pull request #2234 et la section de PEP-8 liée dans l’issue. Identifiez des cas d’utilisation concrets pour déclarer une API publique dans les sources Python, notamment l’effet relevé sur les star imports ; la tâche est considérée comme terminée lorsqu’une direction et un périmètre convenus sont définis, plutôt qu’avec un patch d’implémentation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Description of issue or feature request:
As a result of discussion in https://github.com/theupdateframework/python-tuf/pull/2234, opening this issue to make consensus on eventually declaring public API directly in Python sources.
Current behavior:
Developers can explore API provided by python-tuf using RTD pages. As per PEP-8 standard, __all__ could be considered to declare public API. Note by doing so, this also affects start imports.
Expected behavior:
Identify possible use-cases for declaring public API in Python sources.
- Langage dominant
- Python
- Étoiles
- 1.7k
- Forks
- 304
- Merge moyen
- 9 h 25 min
- PR mergées (30 j)
- 14
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 theupdateframework/python-tuf
-
switch to main branch?Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
theupdateframework/python-tuf#3001 ·
Les mainteneurs répondent en général sous 10 jours
-
Difficulté 4/5 3-5 jours Accessibilité débutants 42/100
theupdateframework/python-tuf#2979 · 1 commentaire ·
Les mainteneurs répondent en général sous 10 jours
-
Use Immutable ReleasesOuverteenhancement github_actions
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
theupdateframework/python-tuf#2920 · 1 commentaire · 2 réactions ·
Les mainteneurs répondent en général sous 10 jours
-
Investigate/test fetcher retriesOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
theupdateframework/python-tuf#2842 · 3 commentaires ·
Les mainteneurs répondent en général sous 10 jours
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
theupdateframework/python-tuf#2836 · 7 commentaires ·
Les mainteneurs répondent en général sous 10 jours
Toutes les issues de theupdateframework/python-tuf
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
PedestrianDynamics/pyFDS-Evac#199 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
521xueweihan/HelloGitHub#3790 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
sandialabs/atlas-ui-3#978 ·
Les mainteneurs répondent en général sous 1 jour
-
area: tests perceived difficulty: 2
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
Nitjsefnie-Harness-Commons/daedalus#1255 ·
Les mainteneurs répondent en général sous 1 jour
-
hf-audiolm-qwen: `generate_until` hardcodes `.to("cuda")` and aborts on non-CUDA acceleratorsOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
EleutherAI/lm-evaluation-harness#4256 ·
Les mainteneurs répondent en général sous 1 jour