TritonDataCenter / smartos-live

For more information, please see http://smartos.org/ For any questions that aren't answered there, please join the SmartOS discussion list: https://smartos.topicbox.com/groups/smartos-discuss
1.57k stars 244 forks source link

OS-8207 piadm "BOOT BITS?" header is confusing #951

Closed danmcd closed 3 years ago

danmcd commented 3 years ago

OS-8208 piadm man page formatting errors

danmcd commented 3 years ago

For the man page, looks like you just removed the fences? The code blocks should be indented by eight spaces (and not \t) to render properly.

1.) I did just remove the fences. 2.) They aren't indented by '\t', they are indented by literally one space. (I had emacs confirm this by uttering "M-x tabify" and literally nothing changed.)

The man rendering on the command line looks fine, but the github MD-to-html does mess them up rather badly. Reintroduced the fences, kept the single-space indent, however.

bahamat commented 3 years ago

Ok, it looks fine on SmartOS, but on macOS it has some weird highlighting. Do we care?

danmcd commented 3 years ago

I don't think we care about it being directly rendered on MacOS.