docs(wiki): added more rules and explanation on how to use the prompt in docforge wiki
This commit is contained in:
@@ -546,6 +546,20 @@ Example:
|
||||
|
||||
---
|
||||
|
||||
# Type parity (`.pyi` stubs and `py.typed`)
|
||||
|
||||
Documented APIs ship matching type information:
|
||||
|
||||
- Each `.py` module has a synchronized `.pyi` stub in the same package.
|
||||
- Packages expose a `py.typed` marker so type checkers (and consumers)
|
||||
use the authored signatures instead of `Any`.
|
||||
- When signatures change, update the `.py` implementation and its `.pyi`
|
||||
stub together.
|
||||
- Doc-forge documents the docstrings in `.py`; the `.pyi` stub is the
|
||||
machine-consumable signature surface.
|
||||
|
||||
---
|
||||
|
||||
# Parsing guarantees
|
||||
|
||||
GSDFC ensures doc-forge can deterministically extract:
|
||||
|
||||
Reference in New Issue
Block a user