Skip to content

[python] typeddict camelcase docstrings like on the wire instead of snakecase #11355

Closed

Description

docstring update to fix incorrect docstring in the types.py typeddict

docstring has param_name but the object has paramName. Docstring should match the camelCase

Activity

  1. github-actions commented on Jul 22, 2026

    @github-actions
    Contributor

    🎯 Issue Triage

    This issue questions whether TypedDict parameter names in the Python client emitter should use snake_case (Python convention) or camelCase (as they appear on the wire).

    Category: Feature Request (or possible bug, depending on intended behavior)
    Area: emitter:client:python

    ⚠️ No reproduction provided. A minimal repro showing the generated TypedDict and the expected vs actual naming would help clarify the issue.

    🔍 Analysis
    • The Python client emitter (@typespec/http-client-python) generates TypedDict types for model parameters.
    • Python convention (PEP 8) favors snake_case for identifiers, but API wire formats typically use camelCase.
    • The question is whether the TypedDict keys should reflect Python naming conventions or mirror the wire/JSON representation.
    • This has usability implications: snake_case is more Pythonic but requires mapping when constructing requests/parsing responses.
    • No duplicate issues found.
    📝 Suggested next steps
    • Clarify whether this is a bug (current behavior is unintentional) or a feature request (requesting a change or option).
    • Provide a minimal TypeSpec definition and show the generated TypedDict to illustrate the current behavior.
    • Consider whether an emitter option (snake_case vs camelCase) would be appropriate to support both use cases.

    Generated by Agentic Triage

  2. changed the title [-][python] typeddict camelcase params like on the wire instead of snakecase[/-] [+][python] typeddict camelcase docstrings like on the wire instead of snakecase[/+] on Jul 22, 2026
  3. added
    bugSomething isn't working
    and removed
    featureNew feature or request
    on Jul 22, 2026
  4. added a commit that references this issue on Jul 28, 2026
    229470f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

bugSomething isn't workingemitter:client:pythonIssue for the Python client emitter: @typespec/http-client-python

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions