← Back to issue list

storeapi: add docstrings to _client

View original Github issue

Metadata

Project
snapcraft
Number
#1851
Type
pull request
State
merged
Author
daniellimws
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #1851 as commit ef690dba8, adding reStructuredText docstrings to the Store API _client module.

Resolution: closed resolved

Reason: The approved PR was merged as commit ef690dba8, delivering the requested documentation-only change to snapcraft/storeapi/_client.py.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Add reST docstrings to _client I'm not sure what to do for kwargs, so I've left them out for now. - [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] If this is a bugfix. Have you checked that there is a bug report open for the issue you are trying to fix on [bug reports](https://bugs.launchpad.net/snapcraft)? - [x] If this is a new feature. Have you discussed the design on the [forum](https://forum.snapcraft.io)? - [x] Have you successfully run `./runtests.sh static`? - [x] Have you successfully run `./runtests.sh unit`? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #1851 as commit ef690dba8, adding reStructuredText docstrings to the Store API _client module.
stealth/space-bunny-alpha — closed resolved Merged PR #1851 added reStructuredText docstrings to storeapi’s _client client module (commit ef690dba8), improving its documentation.
qwen/qwen3.6-35b-a3b — — Merged. Added reST docstrings to the storeapi _client module. Reviewers approved the changes, noting future migration to type hints and prose docstrings. CI passed and the code was integrated.
qwen3.6-35b-a3b-mtp-q6 — — Merged after adding reST docstrings to the _client module in storeapi. Reviewers approved the changes and noted a future migration to type hints and prose documentation, but the contribution was integrated as-is.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1855 storeapi: add docstrings for _snap_index_client.py snapcraft merged Merged PR #1855 in commit 0ba489d51, adding 32 docstring lines to storeapi/_snap_index_client.py without changing behavior.
78%
#3272 storeapi: improve to channel map docstrings snapcraft merged PR #3272 by sergiusens was merged (commit 304f28293, approved with 1 reviewer), reformatting storeapi channel map docstrings to follow PEP 257 style. Documentation-only change, +7/-19 lines in one file.
71%