Fix typos and lint across smaller data directories by bbatsov · Pull Request #3495 · ocaml/ocaml.org

bbatsov · 2026-02-10T12:22:40Z

Summary

Added siblings_only: true to MD024 config to allow duplicate subheadings under different parents
Fixed markdown lint issues (trailing spaces, blank lines, heading levels) across ~50 files
Fixed typos in conferences ("Workskop" → "Workshop", "Ljublijana, Solvenia" → "Ljubljana, Slovenia"), books ("prerequiresite" → "prerequisite"), industrial users ("analyzis" → "analysis", "Ocaml" → "OCaml"), tool pages ("lifecyle" → "lifecycle", "wether" → "whether"), and more
Added language specifiers to fenced code blocks in platform roadmap (MD040)
Converted bold emphasis used as headings to proper ##### headings in platform roadmap (MD036)
Removed emphasis from persona taglines in platform users doc (MD036) — the linter flags standalone paragraphs that are entirely italic/bold, since it can't distinguish decorative emphasis from emphasis-as-heading

Test plan

npx markdownlint-cli2 reports 0 errors across all targeted directories

voodoos

Thanks looks good to me. Maybe we should find an other way to put the emphasis you removed in 0op_02_users ? With quote blocks maybe ?

voodoos · 2026-02-11T13:49:40Z

data/conferences/2011-ocaml-users-and-developers-workshop.md

-
+## Questions and contact

+If you have any queries or suggestions for the workshop, please contact Didier Remy (<first.last@inria.fr>) or Anil Madhavapeddy (<first.last@cl.cam.ac.uk>).


Do markdown parsers detect mail adresses and add mailto: to the link ? If not we should dot it.

I'm not sure about this, so I'll have to check - most likely we'll have to add the mailto:. For the linter here the problem was links were not marked explicitly as auto-links.

voodoos · 2026-02-11T13:54:42Z

data/tool_pages/platform/0op_02_users.md

 ## (U1) Application Developer

-_Builds OCaml applications to solve real-world problems_
+Builds OCaml applications to solve real-world problems.


This does have an impact on the resulting formatting right ? Is there a correct way to put emphasis here ?

(same for other sections)

It does, so I'm on the fence about this one. The linter thinks such cases should be headings (an entire line with emphasis), but I felt it was better to just make it regular text.

Potentially we can disable this rule, but I guess it's not a big deal in general.

@bbatsov

…es, and docs Fix heading levels in 96 files: - exercises: `# Solution`/`# Statement` → `## Solution`/`## Statement` (87 files) - conferences: `###` → `##` where `##` was skipped (7 files) - root docs: demote duplicate `#` to `##` (2 files) Extracted from #3493, #3494, #3495 by @bbatsov. This PR isolates the purely mechanical heading-level fixes for easy review. Quick review tip — verify this PR only touches heading lines: git diff -U0 --no-color HEAD~1 | grep '^[+-]' | grep -v '^[+-][+-][+-]' | paste - - | sort | uniq -c | sort -rn Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

@bbatsov

Strip trailing whitespace from 13 exercise files. Extracted from #3493, #3494, #3495 by @bbatsov. This commit isolates the purely mechanical trailing whitespace fixes for easy review. Quick review tip — verify this commit only removes trailing whitespace: git diff -U0 --no-color HEAD~1 | grep '^[+-]' | grep -v '^[+-][+-][+-]' | paste - - | sort | uniq -c | sort -rn Every pair should show identical content differing only by trailing blanks. Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

@bbatsov

Strip trailing whitespace from 13 exercise files. Extracted from #3493, #3494, #3495 by @bbatsov. This commit isolates the purely mechanical trailing whitespace fixes for easy review. Quick review tip — verify this commit only removes trailing whitespace: git diff -U0 --no-color HEAD~1 | grep '^[+-]' | grep -v '^[+-][+-][+-]' | paste - - | sort | uniq -c | sort -rn Every pair should show identical content differing only by trailing blanks. Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

) * Fix markdown heading levels (MD025/MD001) across exercises, conferences, and docs Fix heading levels in 96 files: - exercises: `# Solution`/`# Statement` → `## Solution`/`## Statement` (87 files) - conferences: `###` → `##` where `##` was skipped (7 files) - root docs: demote duplicate `#` to `##` (2 files) Safe for exercise rendering: `tool/ood-gen/lib/exercise.ml` splits on `Str.regexp {|#[ ]*Solution|}` which matches `## Solution` equally well since `Str.split` finds the pattern as a substring. Verify this commit only touches heading lines: git diff -U0 --no-color HEAD~1 | grep '^[+-]' | grep -v '^[+-][+-][+-]' | paste - - | sort | uniq -c | sort -rn Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Remove trailing whitespace from exercise files (MD009) Strip trailing whitespace from 13 exercise files. Verify this commit only removes trailing whitespace: git diff -U0 --no-color HEAD~1 | grep '^[+-]' | grep -v '^[+-][+-][+-]' | paste - - | sort | uniq -c | sort -rn Every pair should show identical content differing only by trailing blanks. Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add missing final newline to markdown files (MD047) Add missing final newline to 117 markdown files. Verify this commit only adds final newlines: git diff -U0 --no-color HEAD~1 | grep -c '^\\ No newline at end of file' Should output 117 (one per file, all removed). Co-Authored-By: Bozhidar Batsov <bozhidar@batsov.dev> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Bozhidar Batsov <bozhidar@batsov.dev> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

cuihtlauac · 2026-02-13T11:31:50Z

Heads up: #3500 was just merged, which includes the MD025/MD001 (heading levels), MD009 (trailing whitespace), and MD047 (missing final newline) fixes extracted from this PR. This branch will need a rebase on main to resolve conflicts before it can proceed.

- Add language specifiers to fenced code blocks (MD040) - Convert bold emphasis used as headings to proper h5 headings (MD036) - Remove emphasis from persona taglines to avoid MD036 false positives

bbatsov · 2026-02-13T13:12:14Z

Rebased on main (now that #3500 has landed). Conflicts resolved cleanly.

Regarding the review feedback:

Emphasis in 0op_02_users.md: The italic taglines are preserved — Mechanical markdown lint fixes extracted from #3493, #3494, #3495 #3500 already extracted the MD036-related emphasis removal, so this PR now only contains the typo fixes for that file.
Email autolinks: The <first.last@inria.fr> syntax is kept. Per the CommonMark spec, angle-bracket autolinks automatically generate mailto: links, so this works correctly.

sabine

Thanks, I think overall this is a big improvement.

bbatsov requested a review from avsm as a code owner February 10, 2026 12:22

cuihtlauac mentioned this pull request Feb 10, 2026

Remove dead code: unused function and stale build dep #3496

Merged

voodoos approved these changes Feb 11, 2026

View reviewed changes

cuihtlauac mentioned this pull request Feb 11, 2026

Mechanical markdown lint fixes extracted from #3493, #3494, #3495 #3500

Merged

10 tasks

bbatsov added 2 commits February 13, 2026 15:11

Fix typos and lint across smaller data directories

b703b7d

Fix markdown lint errors in platform tool pages

ff8411a

- Add language specifiers to fenced code blocks (MD040) - Convert bold emphasis used as headings to proper h5 headings (MD036) - Remove emphasis from persona taglines to avoid MD036 false positives

bbatsov force-pushed the fix-typos-lint-data-misc branch from 68d2f53 to ff8411a Compare February 13, 2026 13:12

sabine approved these changes Feb 25, 2026

View reviewed changes

sabine merged commit 528b233 into ocaml:main Feb 25, 2026
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typos and lint across smaller data directories#3495

Fix typos and lint across smaller data directories#3495
sabine merged 2 commits intoocaml:mainfrom
bbatsov:fix-typos-lint-data-misc

bbatsov commented Feb 10, 2026 •

edited

Loading

Uh oh!

voodoos left a comment

Uh oh!

voodoos Feb 11, 2026

Uh oh!

bbatsov Feb 11, 2026

Uh oh!

voodoos Feb 11, 2026

Uh oh!

bbatsov Feb 11, 2026

Uh oh!

cuihtlauac commented Feb 13, 2026

Uh oh!

bbatsov commented Feb 13, 2026

Uh oh!

sabine left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		## Questions and contact

		If you have any queries or suggestions for the workshop, please contact Didier Remy (<first.last@inria.fr>) or Anil Madhavapeddy (<first.last@cl.cam.ac.uk>).

Conversation

bbatsov commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

voodoos left a comment

Choose a reason for hiding this comment

Uh oh!

voodoos Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

bbatsov Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

voodoos Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

bbatsov Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

cuihtlauac commented Feb 13, 2026

Uh oh!

bbatsov commented Feb 13, 2026

Uh oh!

sabine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bbatsov commented Feb 10, 2026 •

edited

Loading