adamdruppe / adrdox

41 stars 15 forks source link

beautify prototype box #9

Closed wilzbach closed 6 years ago

wilzbach commented 8 years ago

image

There's still a lot of visual potential, e.g

http://dpldocs.info/experimental-docs/std.ascii.isAlphaNum.html

adamdruppe commented 6 years ago

Space is a good thing for legibility. In simple functions, it doesn't help but also doesn't hurt, and in complex functions, it is an enormous help. Do an A/B test with my docs and dlang.org with someone. My layout wins hands-down in ever test except the trivial where it doesn't matter anyway..

Does that mean it is perfect? No, but a request to improve/beautify it must

  1. be specific

and

  1. pass a user acceptance A/B test, where less-experienced users are able to quickly find the information they want. A purely aesthetic improvement is ok but only if there's no significant hit on this. Packing text usually hurts with quickly scanning (remember, users rarely read docs, they skim them for what they want at the time).

I hear the criticism that the Params: section and the prototype duplicate some info but there's a separate issue open for that so I'll talk about it there.

I'm gonna close this as "not a bug".