docs(wiki): added more rules and explanation on how to use the prompt in docforge wiki

This commit is contained in:
2026-09-15 14:02:07 +05:30
parent 48631b57c5
commit 27f76c7831
7 changed files with 281 additions and 261 deletions

View File

@@ -466,9 +466,9 @@
</li>
<li class="md-nav__item">
<a href="#pyi-stubs" class="md-nav__link">
<a href="#pyi-stubs-and-pytyped" class="md-nav__link">
<span class="md-ellipsis">
.pyi stubs
.pyi stubs and py.typed
</span>
</a>
@@ -743,11 +743,14 @@ package docstring, which is exported verbatim into
<li>Use <code>Args:</code>, <code>Returns:</code>, <code>Raises:</code>, <code>Yields:</code>, <code>Notes:</code>, and <code>Example:</code>
sections at function and method level.</li>
<li>Always update the matching <code>.pyi</code> stub alongside the <code>.py</code> implementation.</li>
<li>Every distributable package ships a <code>py.typed</code> marker so type checkers
consume the authored signatures instead of <code>Any</code>.</li>
</ol>
<hr />
<h2 id="pyi-stubs"><code>.pyi</code> stubs</h2>
<h2 id="pyi-stubs-and-pytyped"><code>.pyi</code> stubs and <code>py.typed</code></h2>
<p>Every module ships a matching <code>.pyi</code> stub kept in sync with the <code>.py</code>
implementation. When signatures change, update both files.</p>
implementation. When signatures change, update both files. Packages expose a
<code>py.typed</code> marker so consumers and type checkers use the authored signatures.</p>
<hr />
<h2 id="wiki-pages">Wiki pages</h2>
<ol>