ocaml-community / utop

Universal toplevel for OCaml
Other
833 stars 110 forks source link

Consistent Formatting of UTop/Utop/utop #464

Closed christinerose closed 9 months ago

christinerose commented 9 months ago

I've been working on some of the ocaml.org documentation recently, and I'd like to try and make the formatting for UTop consistent across the docs. I've seen it written as Utop, utop, and UTop. It would be great to be able to differentiate between the tool itself and the command or code output.

I propose either UTop (to match the OCaml name format) or Utop for the proper name of the toplevel tool and utop in monospace when talking about the command itself. I also see that sometimes it's UTop like in UTop.set_show_box false, which is fine if that's the way it must be input. Still, the monospace will set it apart from the proper name of the toplevel.

If you agree with the above, which do you all prefer? UTop or Utop?

I've love to get a general consensus so I can make it consistent across the documentation as we progress in edits and in creating new docs.