-
Notifications
You must be signed in to change notification settings - Fork 195
Closed as not planned
Description
I've Reviewed the Code
#1 Incorrect capitalization of 'URL' and punctuation
The term 'URL' should be capitalized and the phrase before 'e.g.' should include a comma for correct punctuation.
Tags: language, readability
Affected code:
17: Now you can just `rendergit` any GitHub url e.g.:Proposed change:
Now you can just `rendergit` any GitHub URL, e.g.:#2 Grammatical error and comma splice
The sentence uses 'There's' with a plural subject and contains a comma splice. It should be 'There are' and use a semicolon (or other appropriate punctuation) instead of a comma.
Tags: language, readability
Affected code:
32: There's a few other smaller options, see the code.Proposed change:
There are a few other smaller options; see the code.#3 Unused variable in generate_tree_fallback
repo_to_single_page.py L151-L153
The local variable prefix_stack is declared but never used, which is dead code and may confuse future maintainers.
Tags: maintainability, code-style
Affected code:
151: lines: List[str] = []
152: prefix_stack: List[str] = []
153: Proposed change:
lines: List[str] = []
Nayjestharshil21
Metadata
Metadata
Assignees
Labels
No labels