BlueJayADAL / BlueJayADAL/JayRadar

DocStrings and Code Docs

Open
#23 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
9
Forks
0
PR merge metrics
No merged PRs in 30d

Description

A complete docs folder should be added. We should look at using a readthedocs template like RobotPY does.

This can be a new folder in the root of the repo.

Also the docstrings for all python files need to be reviewed and updated.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing all Python files and comparing the proposed root-level docs folder with the ReadTheDocs template used by RobotPY. Define the documentation scope before updating docstrings, and consider the work done when the complete docs folder exists and the Python docstrings have been reviewed and updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.