Update example formatting

openshmem-org / specification

OpenSHMEM Application Programming Interface

http://www.openshmem.org

50 stars 32 forks source link

Update example formatting #398

Closed nspark closed 4 years ago

nspark commented 4 years ago

Remove background color
Add frame to examples

Closes #397

BryantLam commented 4 years ago

Would it be worthwhile to make the green and blue coloring darker and/or bolder? The text is readable as is, but it would stand out more if the coloring was more pronounced like in the purple for TYPENAME and TYPE.

nspark commented 4 years ago

Here's an example for which the colors were made darker.

Old: ColorsOld

New: ColorsNew

BryantLam commented 4 years ago

Looks great!

jamesaross commented 4 years ago

Since this is more of an aesthetics thing, it should probably be discussed at the next meeting. I prefer the grey background, although lighter than in rc1 (like 97%) and a grey border rather than black. The github color scheme is about right to me. The border is necessary to identify code examples that cross page breaks. I also prefer that the API blocks be the lighter grey, but without a border in order to distinguish them from the code examples.

nspark commented 4 years ago

@manjugv Could we have some time near the end of Friday's RCM to discuss this?

manjugv commented 4 years ago

@manjugv Could we have some time near the end of Friday's RCM to discuss this?

👍 I have added this to the agenda.

jdinan commented 4 years ago

Replaced by https://github.com/jdinan/specification/pull/16