Skip to content

[docu] Fix 2000 off-by-one mistakes#21257

Open
ferdymercury wants to merge 15 commits intoroot-project:masterfrom
ferdymercury:coredox
Open

[docu] Fix 2000 off-by-one mistakes#21257
ferdymercury wants to merge 15 commits intoroot-project:masterfrom
ferdymercury:coredox

Conversation

@ferdymercury
Copy link
Collaborator

@ferdymercury ferdymercury commented Feb 12, 2026

This Pull request:

Changes or fixes:

As found out by @hageboeck in 5f614f8

there were almost 2000 errors in the online documentation where the members were assigned the documentation of their neighbors. See for example:

image

where the docu is off-by-one.

This fixes it throughout the whole codebase, without disturbing the transient I/O mark, copying what was done by Stephan for TDirectory.h in the linked commit.

Checklist:

  • tested changes locally
  • updated the docs (if necessary)

@hageboeck
Copy link
Member

I agree with @hahnjo that this introduces some bugs. Besides that, I would not touch (and review) 300+ files. I think it makes sense to fix these errors when you have to touch a member anyway, but a global change like this is akin to when the universe became transparent: When you look back in git, you only see the CMB.

@ferdymercury
Copy link
Collaborator Author

ferdymercury commented Feb 12, 2026

I think it makes sense to fix these errors when you have to touch a member anyway, but a global change like this is akin to when the universe became transparent: When you look back in git, you only see the CMB.

This can be partly solved using https://dev.to/ramunarasinga-11/git-blame-ignore-revs-to-ignore-bulk-formatting-changes-5fee

I don't agree here with Stephan: it's much worse to have 2000 (well maybe just 500, if 1500 were just empty ///! with no extra doc) wrongly documented members in our online documentation.

Wrt 300+ files, I can split them in different PR per commit, but then it's worse for the CI

Not doing anything because it clutters github is a developer-centered perspective, that I understand. But also think of the user-centered perspective: "I found yet another wrongly documented thing in ROOT docu"

And also think of the domino effect: if I create another class, I will copy paste one as example that is still wrong, increasing the bugginess size

@github-actions
Copy link

github-actions bot commented Feb 12, 2026

Test Results

    22 files      22 suites   3d 6h 4m 39s ⏱️
 3 794 tests  3 794 ✅ 0 💤 0 ❌
75 411 runs  75 411 ✅ 0 💤 0 ❌

Results for commit 3417339.

♻️ This comment has been updated with latest results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

Comments