القائمة
Sync fake.py project documentation with source code. Scans code and docs, finds misalignments, and auto-fixes them. Pure agent-based - no Python scripts involved.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | update-documentation |
| description | Sync fake.py project documentation with source code. Scans code and docs, finds misalignments, and auto-fixes them. Pure agent-based - no Python scripts involved. |
Operation mode: Pure agent-based documentation synchronization.
When the user asks to sync-documentation, the agent:
This is NOT a Python script - the agent performs all analysis and edits directly.
When sync-documentation is invoked:
Scan source code to identify:
__all__ in fake.py (lines 76-150)@provider decorated methods in Faker class (~lines 400-2000)create_inner_* functions (~lines 5400-5700)CLI class (~lines 6500-7000)DjangoModelFactory, PydanticModelFactory, SQLAlchemyModelFactory, TortoiseModelFactoryStringTemplate, LazyStringTemplateRead and analyze:
README.rst - Features, installation, quick startCONTRIBUTING.rst - Developer setup, testing, PR processAGENTS.md - Agent workflowdocs/recipes.rst - Provider examples (1,859 lines)docs/cheatsheet.rst - Quick tricksdocs/creating_files.rst - File generation basics, StringTemplate/LazyStringTemplatedocs/creating_images.rst - Image formatsdocs/creating_pdf.rst - PDF generationdocs/creating_docx.rst - DOCX generationdocs/creating_odt.rst - ODT generationdocs/creating_archives.rst - ZIP, TAR, EML archivesdocs/factories.rst - Factory integrationsdocs/customisation.rst - Custom Faker/Factory usagedocs/cli.rst - CLI commandsCompare code ground truth against documentation:
| Doc File | Check Against |
|---|---|
README.rst | Features list vs __all__ + provider methods |
CONTRIBUTING.rst | Developer prerequisites vs Makefile/pyproject.toml |
docs/recipes.rst | Provider examples vs actual Faker methods |
docs/cheatsheet.rst | Tricks vs provider methods |
docs/creating_images.rst | 7 formats (PNG, SVG, BMP, GIF, TIF, PPM, JPG) vs create_inner_* |
docs/creating_pdf.rst | PDF methods vs actual implementation |
docs/creating_docx.rst | DOCX methods vs implementation |
docs/creating_odt.rst | ODT methods vs implementation |
docs/creating_archives.rst | ZIP, TAR, EML methods vs implementation |
docs/creating_files.rst | File generation basics, StringTemplate/LazyStringTemplate usage |
docs/factories.rst | Factory classes in __all__ vs actual implementations |
docs/customisation.rst | Customization APIs vs Faker/Factory classes |
docs/cli.rst | CLI commands vs CLI class subcommands |
Common misalignments:
The agent directly edits documentation files to align with code:
SKILL.md is NOT modified - it remains the source of truth for the skill behavior.
After fixing, report:
| File | Audience | Purpose |
|---|---|---|
README.rst | End users | Features, installation, quick start, API overview |
CONTRIBUTING.rst | Contributors | Developer setup, testing, PR process |
AGENTS.md | AI agents | Mission, architecture, agent workflow |
docs/recipes.rst | Users/developers | Provider examples, usage patterns |
docs/cheatsheet.rst | Users/developers | Quick tricks, scientific content |
docs/creating_files.rst | Users/developers | File generation basics, StringTemplate/LazyStringTemplate |
docs/creating_images.rst | Users/developers | Image format generation (PNG, SVG, BMP, GIF, TIF, PPM, JPG) |
docs/creating_pdf.rst | Users/developers | PDF generation |
docs/creating_docx.rst | Users/developers | DOCX generation |
docs/creating_odt.rst | Users/developers | ODT generation |
docs/creating_archives.rst | Users/developers | ZIP, TAR, EML archives |
docs/factories.rst | Users/developers | Django, Pydantic, SQLAlchemy, TortoiseORM factories |
docs/customisation.rst | Users/developers | Custom Faker/Factory usage |
docs/cli.rst | Users/developers | CLI commands and options |
Update when:
Structure to maintain:
__all__ and provider methods)Update when:
Key sections:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Update when:
Update when:
Key sections:
Update when:
Key sections:
Update when:
Update when:
:name: attributeAGENTS.md and docs/*.rst use executable code blocks with :name: attributes:
In Markdown (AGENTS.md):
```python name=test_example
from fake import FAKER
FAKER.name()
```
In RST (docs/*.rst):
.. code-block:: python
:name: test_example
from fake import FAKER
FAKER.name()
When adding examples:
test_<feature>_<scenario><!-- continue: <name> --> in markdown to chain blocks.. code-block:: python with :name: test_<name> for Python.. code-block:: sh for shell commands.. note:: for callouts.. container:: jsphinx-toggle-emphasis for collapsible examplesAll code examples in docs/*.rst should be runnable tests. Use the :name:
attribute to prefix the block name with test_:
.. code-block:: python
:name: test_feature_name
from fake import FAKER
result = FAKER.name()
See `docs/recipes.rst`_See `Creating images`_Before finishing documentation updates:
__all__ and provider methodsname= attributesCLI classDo NOT modify documentation that is auto-generated or managed separately.
Use Agent-Based Sync (sync-documentation) when: