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:04 +05:30
parent 4b0fdfaf85
commit cd031ed5de
7 changed files with 59 additions and 19 deletions

View File

@@ -20,13 +20,16 @@ Key rules:
3. Use `Args:`, `Returns:`, `Raises:`, `Yields:`, `Notes:`, and `Example:`
sections at function and method level.
4. Always update the matching `.pyi` stub alongside the `.py` implementation.
5. Every distributable package ships a `py.typed` marker so type checkers
consume the authored signatures instead of `Any`.
---
## `.pyi` stubs
## `.pyi` stubs and `py.typed`
Every module ships a matching `.pyi` stub kept in sync with the `.py`
implementation. When signatures change, update both files.
implementation. When signatures change, update both files. Packages expose a
`py.typed` marker so consumers and type checkers use the authored signatures.
---