NatLabRockies / NatLabRockies/MoorPy

Wrong comment

Open Beginner friendly
#43 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
53
Forks
38
PR merge metrics
No merged PRs in 30d

Description

Description

The comments here are swapped (There are some other instances):

https://github.com/NREL/MoorPy/blob/master/moorpy/system.py#L1364

I suggest you to fix this adding some constants. e.g. on https://github.com/NREL/MoorPy/blob/master/moorpy/point.py#L4 you can add

POINT_TYPE_FIXED = -1
POINT_TYPE_FREE = 0
POINT_TYPE_COPUPLED = 1

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.

Research direction

Start at moorpy/system.py around line 1364 and inspect the related point-type comments, then search for other swapped instances. Review moorpy/point.py near line 4 for the proposed constants and update the affected comments so each describes the correct point type; done means the comments consistently match their values.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.