Argument Clinic: add reference for the DSL

Open
#1,270 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by locating the existing Argument Clinic documentation and any current DSL references in the devguide. Compare the documented coverage with the requested function-name syntax, parameter-line syntax, and docstring syntax; the work is done when a reference explains the legal syntax for all three areas.

Written by the indexing model from the issue text.

Description

type-feature

We need a better reference for the Argument Clinic DSL:

  • legal syntax for the "function name" line
  • legal syntax for parameter lines
  • legal syntax for docstrings
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/devguide

All issues in python/devguide

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.