Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rendering of code is not very attractive or useable #6

Open
hamishwillee opened this issue Apr 9, 2015 · 2 comments
Open

Rendering of code is not very attractive or useable #6

hamishwillee opened this issue Apr 9, 2015 · 2 comments
Labels

Comments

@hamishwillee
Copy link
Contributor

The CSS for the autogenerated class documentation is not very useable - http://python.dronekit.io/automodule.html

Consider the example below:

  • It is hard to visually distinguish the second class
  • it is hard to work out which functions belong to which class, and functions are just as easy to see as classes so "hide" them
  • the parameters (and returns) are more bold than classes classes, hence distracting.

image

The solution is probably to make classes a little more prominent. Indent any description text for them. Further indent any associated attributes, documentation, functions etc. They might perhaps be a little larger, and function parameters a little smaller.

In addition there is not enough space after tables:

image

@mrpollo
Copy link
Member

mrpollo commented Apr 9, 2015

agreed, this will go out on next release

@hamishwillee
Copy link
Contributor Author

Great, assigned to you :-)

@mrpollo mrpollo removed their assignment May 6, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants