[BUG]: Docs should include IDE setup instructions with a linter plugin to catch common mistakes

Open
#61 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
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the install instructions and programmer's guide to identify where IDE setup guidance belongs. Determine which Python linter plugin and common mistakes should be documented, then verify that the added instructions are clear and cover installation and use.

Written by the indexing model from the issue text.

Description

Problem description

Docs should include IDE setup instructions with a linter plugin to catch common mistakes. I couldn't find anything on that in the install instructions or programmer's guide.

Operating System

Linux

Installed Python Packages

No response

Reproducible example code

No response

Dominant language
Python
Stars
10
Forks
25
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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 robotpy/robotpy-docs

All issues in robotpy/robotpy-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.