nannou icon indicating copy to clipboard operation
nannou copied to clipboard

Inconsistent text styling in the Mesh docs

Open jmg-duarte opened this issue 4 years ago • 5 comments

Hello everyone! I'm currently trying to pick nannou up to learn Rust and get back into creative coding. I've naturally been reading the docs a lot and noticed some inconsistencies, I'm happy to address those and submit a pull request however I just don't know what the standard should be.

So far the functions in the page below writes "mesh" in bold or not at all. https://docs.rs/nannou/0.14.1/nannou/mesh/index.html

My goal with this issue is to understand what the default should be so I can help! Thank you for your time!

jmg-duarte avatar Jul 11 '20 11:07 jmg-duarte

Thanks so much for pointing this out @jmg-duarte, that would be awesome!

You're totally right, I'm guilty of switching between the two. How about we follow the example of the Rust std docs and go with backticks instead of bold?

mitchmindtree avatar Jul 12 '20 18:07 mitchmindtree

In this case the mesh isn't code (i.e. a variable) but rather the concept so personally I would pick between nothing or bold. On other cases where it is clearly a variable/function/etc I would go with backticks.

An "ok" example would be here https://doc.rust-lang.org/std/macro.file.html where macro is neither in bold or monospace since it refers to the abstract concept.

What do you think?

jmg-duarte avatar Jul 12 '20 18:07 jmg-duarte

@mitchmindtree are you still interested in this?

jmg-duarte avatar Oct 20 '20 10:10 jmg-duarte

@jmg-duarte sorry about the late response - yes I agree with your last comment, that sounds good to me!

mitchmindtree avatar Oct 20 '20 11:10 mitchmindtree

I'll work on a sample page and submit a PR then!

jmg-duarte avatar Oct 20 '20 11:10 jmg-duarte