Adyen / Adyen/adyen-python-api-library

[Feature]: Add Python Docstrings to services

Open
#394 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

do not stale Feature
Dominant language
Python
Stars
68
Forks
49
Avg merge
2h 3m
Merged PRs (30d)
2

Description

Feature summary

Generated services don't have Docstrings

Problem statement

Services don't have Docstrings that explain what the services do

Proposed solution

Update code generation to generate Docstrings from the OpenAPI spec file

Alternatives considered

No response

Additional context

No response

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.

Research direction

Start by locating the code-generation entry point and the OpenAPI specification handling used to produce services. Inspect generated Python service files to determine where documentation is emitted. Done means generated services contain docstrings derived from the OpenAPI spec and the generation output is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.