Je suis sur le point de plonger à nouveau dans le code source du module cgi.py car la classe MiniFieldStorage est mentionnée dans la documentation, mais pas documentée. Il m'est venu à l'esprit que je l'ai fait tant de fois que je pourrais peut-être écrire une documentation pour cela. Si je l'ai fait, comment dois-je le soumettre?Quelle est la procédure appropriée pour offrir un correctif à la documentation Python?
Répondre
Je suggérerais de signaler un problème au documentation bug tracker, y compris le correctif bien sûr. Ceci est mentionné dans la section sur contributing sur le site.
Si cela ne fonctionne pas, ou semble lent, je suppose que vous pouvez déterrer les développeurs à bug directement, mais cela peut aussi être considéré comme impoli, alors lisez d'abord sur l'étiquette appropriée.
Il y a une page concernant Documentation Development sur le site officiel qui semble être un bon point de départ. Il semble que vous ajoutiez simplement au traqueur de problème et attachez un correctif de la manière normale.
En particulier, il indique Documenting Python, ce qui semble être un guide plutôt exhaustif sur la documentation de formatage; lignes directrices de style, etc
- 1. Quelle est la forme appropriée?
- 2. Quelle est la bonne pratique de Python pour importer et offrir des fonctionnalités optionnelles?
- 3. CreateRemoteThread, LoadLibrary et PostThreadMessage. Quelle est la méthode IPC appropriée?
- 4. Quelle est la méthode appropriée pour déclencher un événement de contrôle ASP.NET par programme?
- 5. Quelle option de conception est la plus appropriée pour l'auto-correction sur la construction?
- 6. Quelle est la valeur initiale appropriée pour un compteur de performance ElapsedTime?
- 7. Adobe AIR - Quelle est la méthode appropriée pour utiliser un EventListener sur une fenêtre nouvellement créée?
- 8. Identification des fichiers pour un correctif/correctif
- 9. Quelle est la manière la plus sûre/appropriée d'implémenter un modèle singleton thread-safe?
- 10. Quelle est l'utilisation appropriée pour le contrôle MultiView d'ASP.NET?
- 11. Quelle est la différence entre la procédure et la procédure # 'dans Lisp/Clojure?
- 12. Quelle est la raison d'avoir '//' en Python?
- 13. "Slicing" dans la documentation des expressions Python
- 14. Quelle est la source appropriée pour le composant Windows Common Controls 6.0 (MSCOMCTL.OCX)?
- 15. Quelle est la meilleure méthode python pour le chiffrement
- 16. Où est la documentation MOQ?
- 17. Quelle architecture SOA est la plus appropriée pour une application Java?
- 18. Quelle est la syntaxe d'appel d'une procédure stockée dans Oracle
- 19. Extension Python C: signatures de méthodes pour la documentation?
- 20. Quelle est la manière la plus appropriée d'utiliser MemoryMappedViewAccessors de .Net 4.0?
- 21. En Python 2, quelle est la différence entre '/' et '//' lorsqu'il est utilisé pour la division?
- 22. Quelle est la bibliothèque XML la plus utilisée pour C++?
- 23. Quelle est la conception la plus appropriée pour un objet dont la clé de base de données est composée de plusieurs colonnes?
- 24. Quelle est la meilleure architecture pour passer à XMPP?
- 25. C#: Quelle est la méthode C# appropriée pour lire les arguments/paramètres dans les applications de la console?
- 26. Quelle est la documentation * projet * la plus utile que vous avez rencontrée?
- 27. Passer la liste à la procédure Tcl
- 28. Dans le cas d'exceptions de code non gérées, quelle est la chose la plus appropriée pour montrer l'utilisateur final?
- 29. Hibernation pour l'accès à la procédure stockée
- 30. Quelle est l'exception la plus appropriée à lancer si un paramètre de configuration app/web.config requis n'est pas présent?