Skip to content

Document when to use positional-only markers #1020

Description

@hauntsaninja

This was recently the source of confusion that led to a sequence of PRs and reverts that caused a documentation regression, e.g. see python/cpython#100546 python/cpython#98340 python/cpython#91485 and some of the related PRs.

python/cpython#100444 (comment) is a reasonable summary of the current policy.

(Acknowledging there are somewhat related larger discussions, like how to document default values, when to use [] for optional parameters, whether to include types in documentation, but we can document the status quo before we figure those out. If we come up with some really nice solution for types in documentation, that could be a good place for positional-only information to live)

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs: decisionNeeds consensus decision from the core teamtype-featureAdditions; New content or section needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions