Posted in Uncategorized

Docs: Use tags for actual code

   January 6, 2021  1 Comment on Docs: Use tags for actual code

I was wondering if it would be possible to use some inline <code> in the documentation for actual code.
For example here we are using a <strong> tag.
image

Also, I noticed that even on the new docs (in the dev branch) the strong tags are rendered without bold. Is there a reason for that?

Thanks!

Author: Fantashit

1 thought on “Docs: Use tags for actual code”

  1. A word in the middle of a sentence being explained should be strong (MeshBasicMaterial)

    I agree with this, but the order of precedence should be code > bold. So in the case where we’re explaining MeshBasicMaterial, it will always be code, not bold. Introducing a new term such as field of view should be bold though.

Comments are closed.