It seems that the documentation is generated from ...
# generall
loud-lizard-27679
08/18/2023, 7:01 PMIt seems that the documentation is generated from the source code and that process doesn't seem to work correctly in this case. What tool is used for that?
f
fast-nail-55400
08/18/2023, 7:07 PMProbably this script: https://github.com/pantsbuild/pants/blob/main/build-support/bin/generate_docs.py
l
loud-lizard-27679
08/18/2023, 7:08 PMYeah, I had guessed so in the mean time
loud-lizard-27679
08/18/2023, 7:09 PMThe weird thing is that the generated markdown looks just fine to me... On the main branch at least. Maybe it's broken in some earlier branch
loud-lizard-27679
08/18/2023, 7:14 PMYeah, that seems to be the case. On the main branch it generates correct markdown, on the release_2.17.0rc3 tag it's broken.
loud-lizard-27679
08/18/2023, 7:29 PMIs it possible to backport the change that fixed it to the 2.17 branch? Because it would be unfortunate to have broken documentation until the release of 2.18
f
fast-nail-55400
08/18/2023, 7:49 PMWhat is the commit?
fast-nail-55400
08/18/2023, 7:49 PMAnd certainly yes let's backport it.
fast-nail-55400
08/18/2023, 7:50 PMbuild-support/cherry_pick/make_pr.shfast-nail-55400
08/18/2023, 7:50 PMthat script will do the heavy lifting
l
loud-lizard-27679
08/18/2023, 7:50 PMI don't know what the commit is, I just ran the script on both the main branch and the release_2.17.0rc3 tag and saw the difference
f
fast-nail-55400
08/18/2023, 7:51 PMgit log -p -- FILEfast-nail-55400
08/18/2023, 7:52 PMor open an issue and document the differing behavior so someone can look into it
l
loud-lizard-27679
08/18/2023, 7:57 PMOh I think it's actually because the .py file that the documentation is generated from has changed
loud-lizard-27679
08/18/2023, 8:07 PM@fast-nail-55400, I've created a PR for this:
https://github.com/pantsbuild/pants/pull/19622
loud-lizard-27679
08/18/2023, 11:11 PMThanks @fast-nail-55400