Inline code in the docs - the correct way

Jakub Łabaj uaaabbjjkl at gmail.com
Wed Jan 31 15:40:04 UTC 2018


What is the current state of the art of writing inline code in 
the documentation?

Wiki says "use `...` instead of $(D ...)": 
https://wiki.dlang.org/Contributing_to_Phobos#Documentation_style.

Some arguments made here: 
https://github.com/dlang/phobos/pull/5183#issuecomment-281895450 
suggest that backticks, among others, may not work well with 
cross-references as they may contain a code of a different 
language than D.

Still, pretty recent PRs suggest that backticks should be used, 
but only for single words:
- https://github.com/dlang/phobos/pull/5801
- https://github.com/dlang/phobos/pull/5970

I thought of updating the wiki to match the apparent consensus in 
this regard but wanted to make sure if it's really the way to go.


More information about the Digitalmars-d mailing list