helpers icon indicating copy to clipboard operation
helpers copied to clipboard

Linter changes headings in markdown incorrectly

Open gpsaggese opened this issue 5 months ago • 1 comments

Linter is having an issue where it changes all headings in markdown from "helpers task: " to "Helpers Task: " which is fine but it also changes " import ..." to " Import " which could cause problems where headings include paths or functions

Originally posted by @madhurlak0810 in https://github.com/causify-ai/helpers/issues/927#issuecomment-3051946599

gpsaggese avatar Jul 14 '25 00:07 gpsaggese

@gpsaggese As per our Markdown style guide, any code (such as imports, file paths, function or class names) must be wrapped in backticks (e.g., "import foo/bar"). If code isn’t backticked, the linter’s title-casing for headings will mangle it. To avoid confusion, we have two options:

  1. clarify this in the docs (add a small snippet of good and bad headings) in docs/documentation_meta/all.writing_docs.how_to_guide.md
  2. add a lightweight check that fails on un-backticked code in headers in helpers.hmarkdown_headers.

madhurlak0810 avatar Jul 29 '25 23:07 madhurlak0810