rstudio / rstudio/pins-python

Add examples to all board constructor docstrings

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

Nobody has claimed this yet.

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

Description

This issue has no description.

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 all board constructor docstrings in the Python project and review their current content. Add appropriate examples to each constructor docstring, then verify that every board constructor is covered and that the documentation format is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
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.