arcade icon indicating copy to clipboard operation
arcade copied to clipboard

Documentation: Improve style of Attributes section

Open pushfoo opened this issue 3 years ago • 0 comments

Documentation request:

What documentation needs to change?

The rendering & styling of entries in the attributes sections of classes.

Where is it located?

On documentation for classes such as arcade.Sprite

What is wrong with it? How can it be improved?

The current rendering of attributes writes the attribute names for classes as all caps characters: image

This interferes with the following:

  • Searching the page with ctrl-f
  • Legibility, as these can look like python-style constants at a glance

Yes, this ticket his may overlap with #1239. However, integrating table plugins into our theme may be slower than tweaking sphinx config & CSS to make attributes match parameter formatting.

pushfoo avatar Jun 25 '22 23:06 pushfoo