mpfaffenberger / mpfaffenberger/code_puppy

chore: remove em dashes and canned AI-style prose

Open
#608 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
814
Forks
278
Avg merge
2d 5h
Merged PRs (30d)
76

Description

Summary

Audit documentation and code comments for em dashes and canned machine-generated writing patterns. Rewrite the affected prose so it is direct, natural, technically precise, and consistent with the project voice.

Scope

  • Review all documentation files, comments, and docstrings across source code, tests, configuration, examples, and root-level project files.
  • Remove em dash characters. Also replace en dashes when they are being used as sentence punctuation rather than as a legitimate range marker.
  • Rewrite canned or inflated phrasing, including repetitive summaries, unnecessary restatement, fake quotations, excessive sectioning, generic marketing language, and meta commentary that does not help the reader.
  • Prefer short declarative sentences and concrete technical wording.
  • Preserve technical meaning, commands, code samples, identifiers, citations, changelog facts, and intentional quoted material.
  • Keep this focused on documentation prose, comments, and docstrings. Do not casually rewrite runtime behavior or unrelated user-facing copy.

Acceptance criteria

  • No em dash characters remain in documentation, comments, or docstrings.
  • En dashes used as sentence punctuation are removed; legitimate range notation is preserved where appropriate.
  • Documentation and comments no longer contain obvious canned machine-generated filler or redundant prose.
  • Rewrites preserve technical accuracy and do not introduce behavioral changes.
  • A reproducible scan documents how prohibited dash characters were checked.
  • Documentation checks, tests, and required linters pass.

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 by inventorying documentation files, source and test comments, configuration, examples, and root-level project files, then run a reproducible scan for em and en dash characters. Review matching prose for the listed canned-writing patterns while preserving technical content, ranges, quotations, commands, and identifiers. Done means the documented scan is clean where required and documentation checks, tests, and linters pass without behavioral changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.