Have docstring before the block they define

Open
#1,673 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Read PEP 257, especially the guidance on docstring placement, then inspect the SDK's Python modules for docstrings that appear after the blocks they describe. Done means the relevant docstrings precede their defined blocks and the existing test suite still passes.

Written by the indexing model from the issue text.

Description

bug

We should comply with https://peps.python.org/pep-0257/ in particular the docstrings should be before the block they define

Dominant language
Python
Stars
37
Forks
16
Avg merge
3d 18h
Merged PRs (30d)
57

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 scaleway/scaleway-sdk-python

All issues in scaleway/scaleway-sdk-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.