<@U0270C8HAHW> It has been awhile since you did so...
# developmentp
proud-dentist-22844
03/21/2025, 1:47 AM@fresh-cat-90827 It has been awhile since you did some work standardizing doc formatting. I'm looking at doing something similar now. So, a couple of questions:
Do you remember why you indented the bullet list? I was just going through removing the indent on a backend I added. Looking at your PR however gave me pause.
https://github.com/pantsbuild/pants/pull/19363/files#diff-2210ee1cf71d8969d320325104ccb332705f374a1b03b1388114f6207207d5feR222-R225
Do you remember why you switched from fenced code blocks (
Copy code
``) to indented blocks? `softwrap` actually mangles the fenced syntax, so I'm thinking of adjusting `softwrap` to better preserve them. Are there any other reasons to avoid fenced code blocks?
<https://github.com/pantsbuild/pants/pull/19363/files#diff-21899df9bd0ea46bb30db6c19a63c59e63d05adccc99cbe6bdf3978a4ad6cccfL463-L470>
And when did you add✅ 1
proud-dentist-22844
03/21/2025, 2:37 AMOh cool. You also added a docstring style guide I haven't seen before: https://github.com/pantsbuild/pants/pull/19365
And that guide has changed since then:
https://www.pantsbuild.org/stable/docs/contributions/development/style-guide#reference-docs
https://github.com/pantsbuild/pants/pull/20435/files#diff-9648b4584e1b2c29f72ad3fab0a547337bece8e63998684f5e3a9e26e3891b93R421
proud-dentist-22844
03/21/2025, 2:42 AMSo, answering my own question using that doc:
• The style guide says to use
*f
fresh-cat-90827
03/21/2025, 6:04 AMHey! Yes, it's been a while, but I am glad you figured it out :)
3 Views