preguntar acerca de documentation

Dans son état actuel, cette question ne convient pas à notre format de questions-réponses. Nous nous attendons à ce que les réponses soient étayées par des faits, des références ou une expertise, mais cette question suscitera probablement un débat, d …

Tout est dans le titre, vraiment. J'ai besoin d'une liste de codes d'erreur STOP (écran bleu) afin que lorsque j'en vois un, je puisse le rechercher. On pourrait penser que cela serait documenté quelque part, mais je serai sacrément si je peux le tro …

Je cherche de la documentation Windows DDK, mais je ne la trouve nulle part - pas même dans MSDN. Par exemple, je ne trouve pas la documentation de la fonction KeGetActiveProcessors, pour obtenir le nombre de processeurs actifs. ... …

Le bouton "Démarrer" de Windows faisait vraiment partie de Windows XP et ce n'est qu'une icône dans Windows 7 et 10, mais la plupart de la documentation l'appelle toujours bouton démarrer. Est-ce exact? Est-ce acceptable? Spécialement lorsque nous …

J'ai un collègue qui insiste sur le fait que son code n'a pas besoin de commentaires, c'est "auto-documenter." J'ai examiné son code, et bien qu'il soit plus clair que le code que j'ai vu d'autres produire, Je ne suis toujours pas d'accord que le co …

Ok, donc j'ai lu à la fois PEP 8 et pep 257, et j'ai écrit beaucoup de docstrings pour les fonctions et les classes, mais je ne suis pas sûr de ce qui devrait aller dans un module docstring. J'ai pensé, au minimum, qu'il devrait documenter les fonct …

Quelle est la meilleure façon de baliser les méthodes / URL pour un webservice RESTful utilisant ReST / Sphinx? Existe-t-il un domaine par défaut qui convient au marquage des URL avec leurs paramètres possibles, leurs méthodes HTTP, leurs en-têtes et …

J'écris de la documentation en utilisant le format Rest (REST) pour la génération ultérieure de pages web en utilisant Sphinx, et je ne trouve pas de moyen d'écrire du texte "gras italique". Il y a des marqueurs de la soi-disant 'accent' (italique) …

Est-il un moyen d'afficher automatiquement les variables var1 et var2 et de leurs valeurs d'initialisation dans le sphinx de la documentation? class myClass(): """ Description for class """ def __init__(self, par1, par2): …

Je cherche un moyen rapide de produire automatiquement des documents D'API REST à partir d'une API REST Flask que j'ai écrite. Est-ce que quelqu'un connaît des outils qui peuvent le faire et comment je baliserais le code? ... …