Skip to content

add Topiary to “Formatting Your Code” #3097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

toastal
Copy link

@toastal toastal commented May 10, 2025

Topiary is a viable code formatter for OCaml projects. My favorite feature compared to its competitor is that Topiary can be configured to use tab indentation for user accessibility (which affects me). While Topiary can be configured, it isn’t as intuitive to configure as many other code formatters that just look for a specific file in a specific location.

Additionally, I removed the implicit assumptions of OCamlFormat in the description & title since the sidebar & URL slug generically state “Formatting Your Code” without specifying a tool. This also required moving the file whose name implied OCamlFormat.

It would have been nice to use a callout/admonition for the “TIP:”, but Markdown does not support this feature.

1

Footnotes

  1. Please consider giving up MS GitHub or offering a non-proprietary, non-US-corporate-controlled mirror for this free software project. I wish to delete this Microsoft account in the future, but I need more projects like this to support alternative methods to send patches & contribute.

@cuihtlauac cuihtlauac requested review from cuihtlauac and sabine May 12, 2025 09:34
@toastal toastal force-pushed the topiary-formatter branch from 96968a0 to 9819bc3 Compare May 16, 2025 07:40
@bbatsov
Copy link
Contributor

bbatsov commented May 19, 2025

You've changed the URL of the page, so you'll need to add some redirect from the old one.

@toastal toastal force-pushed the topiary-formatter branch from 9819bc3 to d7fe9ec Compare May 19, 2025 12:51
@toastal
Copy link
Author

toastal commented May 19, 2025 via email

@toastal toastal force-pushed the topiary-formatter branch 6 times, most recently from 8218789 to 37591b4 Compare May 19, 2025 13:50
@toastal toastal force-pushed the topiary-formatter branch from 37591b4 to bed1873 Compare May 19, 2025 13:53
@bbatsov
Copy link
Contributor

bbatsov commented May 19, 2025

I don’t think this is true. The Markdown YAML heading thing’s id value
has not changed. However, the filename (& title) should change as it
doesn’t reflect that id (& by proxy the URL slug) as well as the
sidebar’s “Formatting your Code” — else you don’t want to give the wrong
impression that there is just one formatter.

My bad. I saw the filename change and at first I assume that the slug was changed to match it.

@toastal toastal force-pushed the topiary-formatter branch from bed1873 to e2c017b Compare May 19, 2025 14:39
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.

2 participants