Skip to content

Create documentation and tutorials for type manipulation #9

@AliiiBenn

Description

@AliiiBenn

Description

Create documentation and tutorials for type manipulation patterns.

Motivation

The PEP 827 and implementation provide powerful features, but users need guidance on how to use them effectively.

Topics to cover

Basic Usage

  • Getting started with type manipulation
  • Using Iter, Attrs, Members
  • Accessing types with GetMemberType

Type Utilities

  • Building Pick, Omit, Partial, Required
  • Using KeyOf for dynamic key access

Real-world Patterns

  • ORM query builder types
  • API request/response types
  • Data validation types

Advanced

  • Custom type operators
  • Recursive types
  • Performance optimization

Output

  • Add examples to the README
  • Create docs/ directory with tutorials
  • Add docstrings to public APIs

Acceptance criteria

  • README updated with examples
  • Tutorial docs created
  • Public APIs documented

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions