rstudio / rstudio/pins-python

Add return type annotation to `pin_list`

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

Nobody has claimed this yet.

Dominant language
Python
Stars
59
Forks
11
PR merge metrics
No merged PRs in 30d

Description

I think this should always be a list of strings, it would be good to indicate such since it doesn't look like LSPs like Pylance are good at inferring this through static analysis.

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

Locate the pin_list definition and inspect nearby type annotations to follow the project's conventions. Add the return annotation indicating a list of strings, then run the relevant test suite and confirm the annotation is exposed without changing runtime behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.