Yup, the rate limiter comments are unhelpful. A top level comment explaining the... | Hacker News

Hacker News new | past | comments | ask | show | jobs | submit

login

omegalulw on Sept 4, 2021 | parent | context | favorite | on: Writing Well-Documented Code – Learn from Examples

Yup, the rate limiter comments are unhelpful. A top level comment explaining the idea is fine (and very useful) but code should largely be self documenting.

axiosgunnar on Sept 5, 2021 [–]

Which it often is, but they still wrote a comment, leading to ridiculous stuff along the lines of

> // Returns None is x = 0

if x = 0 { return None }

Join us for AI Startup School this June 16-17 in San Francisco!
Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact