bcgov / bcgov/ligo-lib

General Coding Style, Formatting, Indentation, Cleanup

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

Description

https://github.com/bcgov-c/data-linking/blob/develop-2.0/lib/cdi-linking/cdilinker/linker/chunked_link.py#L119

review comment: Probably I would not shift the appendfile ...
upto two tabs; instead I would shift it upto 4 spaces (assuming that is set as equivalent of one tab);
This is more of a style guideline (and true for multiple places in the code); however as we do not have any style guideline yet I think we are good.

Review comment (https://github.com/bcgov-c/data-linking/blob/develop-2.0/lib/cdi-linking/cdilinker/plugins/field_category.py#L34): very confusing - not so intuitive name
What does it do? That's hard to tell from the name
After reading other files I understood 'u' implies unmatched.

I see libraries to aid API documentation generation but I did not dig whether it is fully functional or not, whether we are writing code and adding comment in a particular way or not and whether the generated API doc would be useful enough or not ...

What is about removing commented out parts/code? (I am guilty too :D )

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked locations in chunked_link.py and plugins/field_category.py, then inspect the surrounding library for related formatting, naming, documentation, and commented-out code. The issue has no defined scope or tests; completion would require an agreed coding-style cleanup plan and clear acceptance criteria for the proposed changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.