tldr-pages/tldr

Pattern Findings

28 matches across 9 categories. Click a row to expand file-level details.

Hyper-Verbose Identifiers6 hits · 6 pts

Severity	File	Line	Snippet
LOW	scripts/update-command.py	76	def take_cmd_example_with_common_part(cmd_examples: list[str], common_part: str) -> str:
LOW	scripts/update-command.py	92	def find_cmd_example_with_common_part(common_part: str, page_text: str) -> list[str]:
LOW	scripts/set-alias-page.py	120	def generate_alias_page_content(
LOW	scripts/set-alias-page.py	221	def get_alias_command_in_page(path: Path, alias_pattern: str) -> AliasPageContent:
LOW	scripts/set-alias-page.py	285	def sync_alias_page_to_locale(pages_dir: Path, alias_page: AliasPage) -> list[Path]:
LOW	scripts/_common.py	400	def test_create_argument_parser():

Dead Code3 hits · 6 pts

Severity	File	Line
MEDIUM	scripts/update-command.py	232
MEDIUM	scripts/update-command.py	234
MEDIUM	scripts/update-command.py	237

Deep Nesting6 hits · 6 pts

Severity	File	Line
LOW	scripts/set-alias-page.py	442
LOW	scripts/set-see-also.py	221
LOW	scripts/set-page-title.py	166
LOW	scripts/_common.py	95
LOW	scripts/set-more-info-link.py	213
LOW	scripts/pdf/render.py	20

Magic Placeholder Names1 hit · 5 pts

Severity	File	Line	Snippet
HIGH	pages/common/aider.md	8	`aider --model {{model_name}} --api-key {{your_api_key}}`

Fake / Example Data4 hits · 4 pts

Severity	File	Line	Snippet
LOW	pages.ko/common/sd.md	8	`{{echo 'lorem ipsum 23 '}} \| sd '\s+$' ''`
LOW	pages.ko/common/csvgrep.md	14	- "이름" 열에서 "John Doe"가 포함되지 않는 행 찾기:
LOW	pages/common/sd.md	8	`{{echo 'lorem ipsum 23 '}} \| sd '\s+$' ''`
LOW	pages/common/csvgrep.md	15	- Find rows in which the "name" column does NOT include the string "John Doe":

Excessive Try-Catch Wrapping3 hits · 3 pts

Severity	File	Line	Snippet
MEDIUM	scripts/send-to-bot.py	51	print("Error sending data to tldr-bot:", str(e), file=sys.stderr)
MEDIUM	scripts/send-to-bot.py	81	print("Error sending data to tldr-bot!", file=sys.stderr)
LOW	scripts/wrong-filename.py	66	except Exception as exc:

Redundant / Tautological Comments2 hits · 3 pts

Severity	File	Line	Snippet
LOW	scripts/_common.py	82	# Check if SystemExit is raised
LOW	scripts/_common.py	407	# Check if each expected argument is added with the correct configurations

Self-Referential Comments1 hit · 3 pts

Severity	File	Line	Snippet
MEDIUM	scripts/build.sh	57	# Create the zip archive

Over-Commented Block2 hits · 2 pts

Severity	File	Line	Snippet
LOW	scripts/check-pr.sh	1	#!/usr/bin/env bash
LOW	scripts/test.sh	1	#!/usr/bin/env bash