maxspahn / maxspahn/robot_mpcs
Documentation and naming of variables
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
While the repo is quite handy to design and create mpc solvers, it is a bit tricky to understand the variables solely from the naming. I think a little documentation and/or renaming of some variables would help a lot for easier usage.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue does not name files, variables, entry points, or tests. Start by surveying the solver code and its public variable names, then identify which names are ambiguous and where documentation is missing. Done means the selected variables are consistently named or documented so users can understand them without relying on implementation details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- robotics
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100